danger-todoist 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9022770aebb13f12db371446e3aa859e51ef8d17
+  data.tar.gz: f8ad38d6942f9e1eb80916aaa911f70e57ef5c73
+SHA512:
+  metadata.gz: 111347e316c4c0f63307f85860afb35d49cba8914c3e738b250b95f35956608de3a4a00fba0fd4131fdc0b73cdf35e58cd4945c48783c76964cdeabe101f1050
+  data.tar.gz: e4a8a15ca112b13ec1e7ee8ed6e05d4f3919549281a8ff84970dadd83559a4bc87662f691f1410de36d38447570be889df1bf58108bc6e20774cc0c01fede202

data/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+pkg
+.idea/

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+  Enabled: true
+
+Style/StructInheritance:
+  Enabled: false

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+cache:
+  directories:
+    - bundle
+
+rvm:
+  - 2.0
+  - 2.1.3
+  - 2.3.1
+
+script:
+    - bundle exec rake spec

data/Gemfile

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

data/Guardfile

@@ -0,0 +1,19 @@
+# A guardfile for making Danger Plugins
+# For more info see https://github.com/guard/guard#readme
+
+# To run, use `bundle exec guard`.
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2016 Hannes Kaeufler <hannes.kaeufler@gmail.com>
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,53 @@
+[![Build Status](https://travis-ci.org/hanneskaeufler/danger-todoist.svg?branch=master)](https://travis-ci.org/hanneskaeufler/danger-todoist)
+
+# danger-todoist
+
+A description of danger-todoist.
+
+## Installation
+
+    $ gem install danger-todoist
+
+## Usage
+
+    Methods and attributes from this plugin are available in
+    your `Dangerfile` under the `todoist` namespace.
+
+### todoist
+
+<blockquote>Ensure there are no TODOS left in the modified code
+  <pre>
+todoist.warn_for_todos</pre>
+</blockquote>
+
+<blockquote>Set custom warning message
+  <pre>
+todois.message = "Please fix all TODOS"
+todoist.warn_for_todos</pre>
+</blockquote>
+
+<blockquote>List every todo item
+  <pre>
+todoist.warn_for_todos
+todoist.print_todos_table</pre>
+</blockquote>
+
+#### Attributes
+
+`message` - Message to be shown
+
+#### Methods
+
+`warn_for_todos` - Adds a warning if there are todos found in the modified code
+
+`print_todos_table` - Adds a list of offending files to the danger comment
+
+## Development
+
+1. Clone this repo
+2. Run `bundle install` to setup dependencies.
+3. Run `bundle exec rake spec` to run the tests.
+4. Use `bundle exec guard` to automatically have tests run as you make changes.
+5. Make your changes.
+
+

data/Rakefile

@@ -0,0 +1,23 @@
+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
+end
+
+desc 'Run RuboCop on the lib/specs directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb', 'spec/**/*.rb']
+end
+
+desc 'Ensure that the plugin passes `danger plugins lint`'
+task :spec_docs do
+  sh 'bundle exec danger plugins lint'
+end

data/danger-todoist.gemspec

@@ -0,0 +1,49 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'todoist/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  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.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.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'
+
+  # Testing support
+  spec.add_development_dependency 'rspec', '~> 3.4'
+
+  # 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'
+
+  # If you want to work on older builds of ruby
+  spec.add_development_dependency 'listen', '3.0.7'
+
+  # This gives you the chance to run a REPL inside your tests
+  # via:
+  #
+  #    require 'pry'
+  #    binding.pry
+  #
+  # This will stop test execution and let you inspect the results
+  spec.add_development_dependency 'pry'
+end

data/lib/danger_plugin.rb

@@ -0,0 +1 @@
+require "todoist/plugin"

data/lib/danger_todoist.rb

@@ -0,0 +1 @@
+require "todoist/gem_version"

data/lib/todoist/gem_version.rb

@@ -0,0 +1,3 @@
+module Todoist
+  VERSION = "0.0.1".freeze
+end

data/lib/todoist/plugin.rb

@@ -0,0 +1,89 @@
+module Danger
+  #
+  # @example Ensure there are no TODOS left in the modified code
+  #
+  #          todoist.warn_for_todos
+  #
+  # @example Set custom warning message
+  #
+  #          todois.message = "Please fix all TODOS"
+  #          todoist.warn_for_todos
+  #
+  # @example List every todo item
+  #
+  #          todoist.warn_for_todos
+  #          todoist.print_todos_table
+  #
+  # @see  hanneskaeufler/danger-todoist
+  # @tags todos, fixme
+  #
+  class DangerTodoist < Plugin
+    DEFAULT_MESSAGE = "There remain todo items in the modified code.".freeze
+    TODO_REGEXP = /TODO|FIXME/i
+
+    #
+    # Message to be shown
+    #
+    # @attr_writer [String] message Custom message shown when todos were found
+    # @return [void]
+    #
+    attr_writer :message
+
+    #
+    # Adds a warning if there are todos found in the modified code
+    #
+    # @return [void]
+    #
+    def warn_for_todos
+      @todos = []
+      return if files_of_interest.empty?
+
+      diffs_containing_todo_markers
+        .each { |diff| @todos << Todo.new(diff.path) }
+
+      warn(message) unless @todos.empty?
+    end
+
+    #
+    # Adds a list of offending files to the danger comment
+    #
+    # @return [void]
+    #
+    def print_todos_table
+      return if @todos.nil?
+      return if @todos.empty?
+
+      markdown("#### Todos left in files")
+
+      @todos.each { |todo| markdown("- #{todo.file}") }
+    end
+
+    private
+
+    def message
+      return @message unless @message.nil?
+      DEFAULT_MESSAGE
+    end
+
+    def files_of_interest
+      git.modified_files + git.added_files
+    end
+
+    def diffs_of_interest
+      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/spec_helper.rb

@@ -0,0 +1,59 @@
+require "pathname"
+ROOT = Pathname.new(File.expand_path("../../", __FILE__))
+$LOAD_PATH.unshift((ROOT + "lib").to_s)
+$LOAD_PATH.unshift((ROOT + "spec").to_s)
+
+require "bundler/setup"
+require "pry"
+
+require "rspec"
+require "danger"
+
+# Use coloured output, it"s the best.
+RSpec.configure do |config|
+  config.filter_gems_from_backtrace "bundler"
+  config.color = true
+  config.tty = true
+end
+
+require "danger_plugin"
+
+# These functions are a subset of https://github.com/danger/danger/blob/master/spec/spec_helper.rb
+# If you are expanding these files, see if it"s already been done ^.
+
+# A silent version of the user interface,
+# it comes with an extra function `.string` which will
+# strip all ANSI colours from the string.
+
+# rubocop:disable Lint/NestedMethodDefinition
+def testing_ui
+  @output = StringIO.new
+  def @output.winsize
+    [20, 9999]
+  end
+
+  cork = Cork::Board.new(out: @output)
+  def cork.string
+    out.string.gsub(/\e\[([;\d]+)?m/, "")
+  end
+  cork
+end
+# rubocop:enable Lint/NestedMethodDefinition
+
+# Example environment (ENV) that would come from
+# running a PR on TravisCI
+def testing_env
+  {
+    "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
+    "TRAVIS_PULL_REQUEST" => "800",
+    "TRAVIS_REPO_SLUG" => "artsy/eigen",
+    "TRAVIS_COMMIT_RANGE" => "759adcbd0d8f...13c4dc8bb61d",
+    "DANGER_GITHUB_API_TOKEN" => "123sbdq54erfsd3422gdfio"
+  }
+end
+
+# A stubbed out Dangerfile for use in tests
+def testing_dangerfile
+  env = Danger::EnvironmentManager.new(testing_env)
+  Danger::Dangerfile.new(env, testing_ui)
+end

data/spec/todoist_spec.rb

@@ -0,0 +1,122 @@
+require File.expand_path("../spec_helper", __FILE__)
+
+module Danger
+  describe Danger::DangerTodoist do
+    it "should be a plugin" do
+      expect(Danger::DangerTodoist.new(nil)).to be_a Danger::Plugin
+    end
+
+    describe "with Dangerfile" do
+      before do
+        @dangerfile = testing_dangerfile
+        @todoist = @dangerfile.todoist
+      end
+
+      context "changed files containing a todo" do
+        before do
+          modified = Git::Diff::DiffFile.new(
+            "base",
+            path:  "some/file.rb",
+            patch: "+ TODO: some todo"
+          )
+          added = Git::Diff::DiffFile.new(
+            "base",
+            path:  "another/stuff.rb",
+            patch: "+ fixme: another todo"
+          )
+
+          allow(@dangerfile.git).to receive(:diff_for_file)
+            .with("some/file.rb")
+            .and_return(modified)
+
+          allow(@dangerfile.git).to receive(:diff_for_file)
+            .with("another/stuff.rb")
+            .and_return(added)
+
+          allow(@dangerfile.git).to receive(:modified_files)
+            .and_return([modified_with_todo])
+          allow(@dangerfile.git).to receive(:added_files)
+            .and_return([added_with_todo])
+        end
+
+        it "warns when files in the changeset" do
+          @todoist.warn_for_todos
+
+          expect(warnings).to eq([DangerTodoist::DEFAULT_MESSAGE])
+        end
+
+        it "allows the message to be changed" do
+          @todoist.message = "changed message"
+          @todoist.warn_for_todos
+
+          expect(warnings).to eq(["changed message"])
+        end
+
+        it "can print a report" do
+          @todoist.warn_for_todos
+          @todoist.print_todos_table
+
+          expect(markdowns).to eq(
+            [
+              "#### Todos left in files",
+              "- some/file.rb",
+              "- another/stuff.rb"
+            ]
+          )
+        end
+      end
+
+      context "changed files not containing a todo" do
+        before do
+          modified = Git::Diff::DiffFile.new(
+            "base",
+            path:  "some/file.rb",
+            patch: "+ some added line"
+          )
+          allow(@dangerfile.git).to receive(:diff_for_file)
+            .with("some/file.rb")
+            .and_return(modified)
+
+          allow(@dangerfile.git).to receive(:modified_files)
+            .and_return([modified_with_todo])
+          allow(@dangerfile.git).to receive(:added_files).and_return([])
+        end
+
+        it "reports nothing" do
+          @todoist.warn_for_todos
+          @todoist.print_todos_table
+
+          expect(warnings).to be_empty
+          expect(markdowns).to be_empty
+        end
+      end
+
+      it "does nothing when no files are in changeset" do
+        allow(@dangerfile.git).to receive(:modified_files).and_return([])
+        allow(@dangerfile.git).to receive(:added_files).and_return([])
+
+        @todoist.warn_for_todos
+        @todoist.print_todos_table
+
+        expect(warnings).to be_empty
+        expect(markdowns).to be_empty
+      end
+    end
+
+    def modified_with_todo
+      "some/file.rb"
+    end
+
+    def added_with_todo
+      "another/stuff.rb"
+    end
+
+    def warnings
+      @dangerfile.status_report[:warnings]
+    end
+
+    def markdowns
+      @dangerfile.status_report[:markdowns].map(&:message)
+    end
+  end
+end

metadata

@@ -0,0 +1,202 @@
+--- !ruby/object:Gem::Specification
+name: danger-todoist
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Hannes Käufler
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-09-03 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: danger-plugin-api
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.4'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.41'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.7'
+- !ruby/object:Gem::Dependency
+  name: listen
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.0.7
+- !ruby/object:Gem::Dependency
+  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.
+email:
+- hannes.kaeufler@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- danger-todoist.gemspec
+- lib/danger_plugin.rb
+- lib/danger_todoist.rb
+- lib/todoist/gem_version.rb
+- lib/todoist/plugin.rb
+- spec/spec_helper.rb
+- spec/todoist_spec.rb
+homepage: https://github.com/hanneskaeufler/danger-todoist
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.5.1
+signing_key: 
+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/spec_helper.rb
+- spec/todoist_spec.rb