danger-todoist 1.1.0 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6a9300d0182df857bcceb2f773095c36924e04dc
-  data.tar.gz: 89cb101a4effda323f9fa5e8937ee1d8c4809a4e
+  metadata.gz: ece9544107e09397ee672b6f3a0f0aad2797c664
+  data.tar.gz: 93e8a542c62490dbb51f3adf378abc17f72f92c5
 SHA512:
-  metadata.gz: 1135e1b4d7a58c5a49c8d071719f7a088a63c49bcd8da113558799e2af3b860e8fd97bc6504307076cef47f7c24ff6a97fdb61afc8ece63a44bde34de0559ebd
-  data.tar.gz: 558aac3afe414446e3730bdeb8229793b88612c1f2cc073f4ec8c7e0b34d68bf7b61891a2bc5aa7593258ef3859a45ebd1425c1b1003677ed83a86a59bf1a0c8
+  metadata.gz: 8ba5ef9e357c74f9194bac0348134d761cb4a8bdf9265f0879dc2414ac464be5fb17545fbf05b4de3282e85f608824825f8f6f33a2fe59e85a54dd15c43dac7d
+  data.tar.gz: 27351b576938f30b197705f3731af8b382d3be794208e6c72a7e68ecadca63a9e220afbf2dd2a6b7ea93b133c5f2c0df05e683e4ee8749ed3de9c2855ae92cb5

data/.codeclimate.yml

@@ -0,0 +1,3 @@
+engines:
+  fixme:
+    enabled: false

data/.gitignore

@@ -1,3 +1,6 @@
 .DS_Store
-pkg
 .idea/
+.yardoc/
+Gemfile.lock
+coverage/
+pkg

data/.travis.yml

@@ -12,4 +12,7 @@ before_script:
   - bundle exec danger
 
 script:
-  - bundle exec rake spec
+  - COVERAGE=true bundle exec rake spec
+
+after_script:
+  - bundle exec codeclimate-test-reporter

data/CHANGELOG.md

@@ -1,5 +1,10 @@
 ## master
 
+## 1.2.0
+
+* fixes crash when git returns nil - hanneskaeufler
+* allow to specify todo keywords - hanneskaeufler
+
 ## 1.1.0
 
 * add support for multiline comments - hanneskaeufler

data/Gemfile

@@ -1,4 +1,4 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 # Specify your gem's dependencies in danger-todoist.gemspec
 gemspec

data/Guardfile

@@ -3,8 +3,8 @@
 
 # To run, use `bundle exec guard`.
 
-guard :rspec, cmd: 'bundle exec rspec' do
-  require 'guard/rspec/dsl'
+guard :rspec, cmd: "bundle exec rspec" do
+  require "guard/rspec/dsl"
   dsl = Guard::RSpec::Dsl.new(self)
 
   # RSpec files

data/README.md

@@ -1,8 +1,8 @@
-[![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)
+[![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) [![Code Climate](https://codeclimate.com/github/hanneskaeufler/danger-todoist/badges/gpa.svg)](https://codeclimate.com/github/hanneskaeufler/danger-todoist) [![Test Coverage](https://codeclimate.com/github/hanneskaeufler/danger-todoist/badges/coverage.svg)](https://codeclimate.com/github/hanneskaeufler/danger-todoist/coverage)
 
 # danger-todoist
 
-danger-todoist is a [https://danger.systems](danger) plugin to automatically notify you of
+danger-todoist is a [https://danger.systems](https://danger.systems) plugin to automatically notify you of
 todos left in the code of a pull/merge request.
 
 ## Installation

data/Rakefile

@@ -1,23 +1,23 @@
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
-require 'rubocop/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 RSpec::Core::RakeTask.new(:specs)
 
 task default: :specs
 
 task :spec do
-  Rake::Task['specs'].invoke
-  Rake::Task['rubocop'].invoke
-  Rake::Task['spec_docs'].invoke
+  Rake::Task["specs"].invoke
+  Rake::Task["rubocop"].invoke
+  Rake::Task["spec_docs"].invoke
 end
 
-desc 'Run RuboCop on the lib/specs directory'
+desc "Run RuboCop on the lib/specs directory"
 RuboCop::RakeTask.new(:rubocop) do |task|
-  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+  task.patterns = ["lib/**/*.rb", "spec/**/*.rb"]
 end
 
-desc 'Ensure that the plugin passes `danger plugins lint`'
+desc "Ensure that the plugin passes `danger plugins lint`"
 task :spec_docs do
-  sh 'bundle exec danger plugins lint'
+  sh "bundle exec danger plugins lint"
 end

data/danger-todoist.gemspec

@@ -1,49 +1,51 @@
 # coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'todoist/gem_version.rb'
+require "todoist/gem_version.rb"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'danger-todoist'
+  spec.name          = "danger-todoist"
   spec.version       = Todoist::VERSION
-  spec.authors       = ['Hannes Käufler']
-  spec.email         = ['hannes.kaeufler@gmail.com']
-  spec.description   = %q{A danger plugin for spotting introduced todos.}
-  spec.summary       = %q{Marking something with a todo is very common during implementing a new feature. Often those todos will get missed in code review.}
-  spec.homepage      = 'https://github.com/hanneskaeufler/danger-todoist'
-  spec.license       = 'MIT'
+  spec.authors       = ["Hannes Käufler"]
+  spec.email         = ["hannes.kaeufler@gmail.com"]
+  spec.description   = "A danger plugin for spotting introduced todos."
+  spec.summary       = "Marking something with a todo is very common during implementing a new feature. Often those todos will get missed in code review."
+  spec.homepage      = "https://github.com/hanneskaeufler/danger-todoist"
+  spec.license       = "MIT"
 
   spec.files         = `git ls-files`.split($/)
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.require_paths = ["lib"]
 
-  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+  spec.add_runtime_dependency "danger-plugin-api", "~> 1.0"
 
   # General ruby development
-  spec.add_development_dependency 'bundler', '~> 1.3'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.0"
 
   # Testing support
-  spec.add_development_dependency 'rspec', '~> 3.4'
+  spec.add_development_dependency "rspec", "~> 3.4"
+  spec.add_development_dependency "simplecov", "~> 0.12"
+  spec.add_development_dependency "codeclimate-test-reporter", "~> 1.0.0"
 
   # Linting code and docs
   spec.add_development_dependency "rubocop", "~> 0.41"
   spec.add_development_dependency "yard", "~> 0.8"
 
   # Makes testing easy via `bundle exec guard`
-  spec.add_development_dependency 'guard', '~> 2.14'
-  spec.add_development_dependency 'guard-rspec', '~> 4.7'
+  spec.add_development_dependency "guard", "~> 2.14"
+  spec.add_development_dependency "guard-rspec", "~> 4.7"
 
   # If you want to work on older builds of ruby
-  spec.add_development_dependency 'listen', '3.0.7'
+  spec.add_development_dependency "listen", "3.0.7"
 
   # This gives you the chance to run a REPL inside your tests
   # via:
   #
-  #    require 'pry'
+  #    require "pry"
   #    binding.pry
   #
   # This will stop test execution and let you inspect the results
-  spec.add_development_dependency 'pry'
+  spec.add_development_dependency "pry", "~> 0"
 end

data/lib/todoist/diff_todo_finder.rb

@@ -1,21 +1,15 @@
 module Danger
   # Identify todos in a set of diffs
   class DiffTodoFinder
-    TODO_REGEXP = /
-      ^\+                 # we only look at additions, marked by + in diffs
-      \s*                 # followed by optional space
-      [^a-z0-9\+\s]+      # anything looking like a comment indicator
-      (\n\+)?             # allow multiline comment markers
-      \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 initialize(keywords)
+      @keywords = keywords
+    end
 
     def find_diffs_containing_todos(diffs)
       todos = []
+      regexp = todo_regexp
       diffs.each do |diff|
-        matches = diff.patch.scan(TODO_REGEXP)
+        matches = diff.patch.scan(regexp)
         next if matches.empty?
 
         matches.each do |match|
@@ -24,5 +18,20 @@ module Danger
       end
       todos
     end
+
+    private
+
+    def todo_regexp
+      /
+      ^\+                 # we only look at additions, marked by + in diffs
+      \s*                 # followed by optional space
+      [^a-z0-9\+\s]+      # anything looking like a comment indicator
+      (\n\+)?             # allow multiline comment markers
+      \s+                 # followed by at least one space
+      (#{@keywords.join("|")})       # our todo indicator
+      [\s:]{1}            # followed by a space or colon
+      (?<text>.*)$        # matching any text until the end of the line
+    /ix
+    end
   end
 end

data/lib/todoist/gem_version.rb

@@ -1,3 +1,3 @@
 module Todoist
-  VERSION = "1.1.0".freeze
+  VERSION = "1.2.0".freeze
 end

data/lib/todoist/plugin.rb

@@ -29,6 +29,7 @@ module Danger
   #
   class DangerTodoist < Plugin
     DEFAULT_MESSAGE = "There remain todo items in the modified code.".freeze
+    DEFAULT_KEYWORDS = %w(TODO FIXME).freeze
 
     #
     # Message to be shown
@@ -38,6 +39,13 @@ module Danger
     #
     attr_writer :message
 
+    #
+    # Keywords to recognize as todos
+    #
+    # @attr_writer [Array] keywords Custom array of strings to identify todos
+    # @return [void]
+    attr_writer :keywords
+
     #
     # Adds a warning if there are todos found in the modified code
     #
@@ -100,7 +108,13 @@ module Danger
       @todos = []
       return if files_of_interest.empty?
 
-      @todos = DiffTodoFinder.new.find_diffs_containing_todos(diffs_of_interest)
+      @todos = DiffTodoFinder.new(keywords)
+                             .find_diffs_containing_todos(diffs_of_interest)
+    end
+
+    def keywords
+      return @keywords unless @keywords.nil?
+      DEFAULT_KEYWORDS
     end
 
     def message
@@ -114,6 +128,7 @@ module Danger
 
     def diffs_of_interest
       files_of_interest
+        .compact
         .map { |file| git.diff_for_file(file) }
     end
   end

data/spec/diff_todo_finder_spec.rb

@@ -2,7 +2,9 @@ require File.expand_path("../spec_helper", __FILE__)
 
 module Danger
   describe Danger::DiffTodoFinder do
-    let(:subject) { Danger::DiffTodoFinder.new }
+    let(:subject) do
+      Danger::DiffTodoFinder.new(%w(TODO FIXME))
+    end
 
     describe "#find_diffs_containing_todos" do
       %w(TODO TODO: todo todo: FIXME fixme FIXME: fixme).each do |marker|
@@ -15,6 +17,24 @@ module Danger
         end
       end
 
+      it "identifies todos with changed finder string" do
+        diff = sample_diff("+ # BUG some todo")
+
+        subject = described_class.new(["BUG"])
+        todos = subject.find_diffs_containing_todos([diff])
+
+        expect(todos).to_not be_empty
+      end
+
+      it "doesnt crash but also doesnt find anything with empty keywords" do
+        diff = sample_diff("+ # BUG some todo")
+
+        subject = described_class.new([])
+        todos = subject.find_diffs_containing_todos([diff])
+
+        expect(todos).to be_empty
+      end
+
       # those comment indicators are ripped off https://github.com/pgilad/leasot
       %w(# {{ -- // /* <!-- <%# % / -# {{! {{!-- {# <%--).each do |comment|
         it "identifies todos in languages with '#{comment}' as comments" do

data/spec/spec_helper.rb

@@ -1,3 +1,10 @@
+require "simplecov"
+if ENV["COVERAGE"]
+  SimpleCov.start do
+    add_filter "/spec/"
+  end
+end
+
 require "pathname"
 ROOT = Pathname.new(File.expand_path("../../", __FILE__))
 $LOAD_PATH.unshift((ROOT + "lib").to_s)

data/spec/todoist_spec.rb

@@ -1,5 +1,6 @@
 require File.expand_path("../spec_helper", __FILE__)
 
+# rubocop:disable Metrics/ModuleLength
 module Danger
   describe Danger::DangerTodoist do
     it "should be a plugin" do
@@ -63,6 +64,13 @@ PATCH
           expect(warnings).to eq(["changed message"])
         end
 
+        it "allows the keywords to be changed" do
+          @todoist.keywords = ["find-nothing"]
+          @todoist.warn_for_todos
+
+          expect(warnings).to be_empty
+        end
+
         it "can print a report, even without warning first" do
           @todoist.print_todos_table
 
@@ -121,6 +129,14 @@ PATCH
         expect(failures).to be_empty
         expect(markdowns).to be_empty
       end
+
+      it "does not raise when git returns nil" do
+        invalid = [nil]
+        allow(@dangerfile.git).to receive(:modified_files).and_return(invalid)
+        allow(@dangerfile.git).to receive(:added_files).and_return([])
+
+        expect { @todoist.warn_for_todos }.to_not raise_error
+      end
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-todoist
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
 platform: ruby
 authors:
 - Hannes Käufler
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-09-30 00:00:00.000000000 Z
+date: 2016-12-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -66,6 +66,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.12'
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -140,14 +168,14 @@ dependencies:
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0'
 description: A danger plugin for spotting introduced todos.
@@ -157,6 +185,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".codeclimate.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".travis.yml"