danger-pivotal_tracker 0.0.2

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in danger-pivotal_tracker.gemspec
+gemspec
+
+gem 'danger-auto_label'
+
+gem 'simplecov', require: false, group: :test

data/Gemfile.lock

@@ -0,0 +1,148 @@
+PATH
+  remote: .
+  specs:
+    danger-pivotal_tracker (0.0.1)
+      danger-plugin-api (~> 1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.6.0)
+      public_suffix (>= 2.0.2, < 4.0)
+    ast (2.4.0)
+    claide (1.0.2)
+    claide-plugins (0.9.2)
+      cork
+      nap
+      open4 (~> 1.3)
+    coderay (1.1.2)
+    colored2 (3.1.2)
+    cork (0.3.0)
+      colored2 (~> 3.1)
+    danger (6.0.9)
+      claide (~> 1.0)
+      claide-plugins (>= 0.9.2)
+      colored2 (~> 3.1)
+      cork (~> 0.1)
+      faraday (~> 0.9)
+      faraday-http-cache (~> 2.0)
+      git (~> 1.5)
+      kramdown (~> 2.0)
+      kramdown-parser-gfm (~> 1.0)
+      no_proxy_fix
+      octokit (~> 4.7)
+      terminal-table (~> 1)
+    danger-auto_label (1.3.1)
+      danger-plugin-api (~> 1.0)
+    danger-plugin-api (1.0.0)
+      danger (> 2.0)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    faraday-http-cache (2.0.0)
+      faraday (~> 0.8)
+    ffi (1.11.1)
+    formatador (0.2.5)
+    git (1.5.0)
+    guard (2.15.0)
+      formatador (>= 0.2.4)
+      listen (>= 2.7, < 4.0)
+      lumberjack (>= 1.0.12, < 2.0)
+      nenv (~> 0.1)
+      notiffany (~> 0.0)
+      pry (>= 0.9.12)
+      shellany (~> 0.0)
+      thor (>= 0.18.1)
+    guard-compat (1.2.1)
+    guard-rspec (4.7.3)
+      guard (~> 2.1)
+      guard-compat (~> 1.1)
+      rspec (>= 2.99.0, < 4.0)
+    jaro_winkler (1.5.3)
+    json (2.2.0)
+    kramdown (2.1.0)
+    kramdown-parser-gfm (1.1.0)
+      kramdown (~> 2.0)
+    listen (3.0.7)
+      rb-fsevent (>= 0.9.3)
+      rb-inotify (>= 0.9.7)
+    lumberjack (1.0.13)
+    method_source (0.9.2)
+    multipart-post (2.1.1)
+    nap (1.1.0)
+    nenv (0.3.0)
+    no_proxy_fix (0.1.2)
+    notiffany (0.1.1)
+      nenv (~> 0.1)
+      shellany (~> 0.0)
+    octokit (4.14.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+    open4 (1.3.4)
+    parallel (1.17.0)
+    parser (2.6.3.0)
+      ast (~> 2.4.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.1.1)
+    rainbow (3.0.0)
+    rake (10.5.0)
+    rb-fsevent (0.10.3)
+    rb-inotify (0.10.0)
+      ffi (~> 1.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.2)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.2)
+    rubocop (0.73.0)
+      jaro_winkler (~> 1.5.1)
+      parallel (~> 1.10)
+      parser (>= 2.6)
+      rainbow (>= 2.2.2, < 4.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 1.4.0, < 1.7)
+    ruby-progressbar (1.10.1)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
+    shellany (0.0.1)
+    simplecov (0.17.0)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    terminal-table (1.8.0)
+      unicode-display_width (~> 1.1, >= 1.1.1)
+    thor (0.20.3)
+    unicode-display_width (1.6.0)
+    yard (0.9.20)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler
+  danger-auto_label
+  danger-pivotal_tracker!
+  guard (~> 2.14)
+  guard-rspec (~> 4.7)
+  listen (= 3.0.7)
+  pry
+  rake (~> 10.0)
+  rspec (~> 3.4)
+  rubocop
+  simplecov
+  yard
+
+BUNDLED WITH
+   2.0.1

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) 2019 Kevin Morton <kevnm67@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,58 @@
+# Danger Pivotal Tracker Plugin
+<!-- TOC depthFrom:1 depthTo:6 withLinks:1 updateOnSave:1 orderedList:0 -->
+
+- [Danger Pivotal Tracker Plugin](#danger-pivotal-tracker-plugin)
+	- [Installation](#installation)
+	- [Usage](#usage)
+	- [Development](#development)
+
+<!-- /TOC -->
+<body>
+  <table>
+    <thead>
+      <tr>
+        <th>Service</th>
+        <th>Badge</th>
+      </tr>
+    </thead>
+    <tbody>
+      <tr>
+        <td>Travis CI (Master)</td>
+        <td><a href="https://travis-ci.com/kevnm67/danger-pivotal_tracker"><img src="https://travis-ci.com/kevnm67/danger-pivotal_tracker.svg?branch=master" /></a></td>
+      </tr>
+      <tr>
+        <td>Travis CI (Develop)</td>
+        <td><a href="https://travis-ci.com/kevnm67/danger-pivotal_tracker"><img src="https://travis-ci.com/kevnm67/danger-pivotal_tracker.svg?branch=develop" /></a></td>
+      </tr>
+      <tr>
+        <td>Code Climate</td>
+        <td><a href="https://codeclimate.com/github/kevnm67/danger-pivotal_tracker/maintainability"><img src="https://api.codeclimate.com/v1/badges/ad4a58bf6d0c81d8e6f4/maintainability" /></a></td>
+      </tr>
+      <tr>
+        <td>Code Coverage</td>
+        <td><a href="https://codeclimate.com/github/kevnm67/danger-pivotal_tracker/test_coverage"><img src="https://api.codeclimate.com/v1/badges/ad4a58bf6d0c81d8e6f4/test_coverage" /></a></td>
+      </tr>
+      </tbody>
+  </table>
+</body>
+
+
+## Installation
+
+    $ gem install danger-pivotal_tracker
+
+## Usage
+
+    Methods and attributes from this plugin are available in
+    your `Dangerfile` under the `pivotal_tracker` namespace.
+
+## 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.
+
+
+![](./docs/images/walter-code-cov.jpeg)

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-pivotal_tracker.gemspec

@@ -0,0 +1,50 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'pivotal_tracker/gem_version.rb'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'danger-pivotal_tracker'
+  spec.version       = PivotalTracker::VERSION
+  spec.authors       = ['Kevin Morton']
+  spec.email         = ['']
+  spec.description   = %q{A short description of danger-pivotal_tracker.}
+  spec.summary       = %q{A longer description of danger-pivotal_tracker.}
+  spec.homepage      = 'https://github.com/kevnm67/danger-pivotal_tracker'
+  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.metadata["yard.run"] = "yri" # use "yard" to build full HTML docs.
+
+  spec.add_runtime_dependency 'danger-plugin-api', '~> 1.0'
+
+  # General ruby development
+  spec.add_development_dependency 'bundler'
+  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"
+  spec.add_development_dependency "yard"
+
+  # 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_pivotal_tracker.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "pivotal_tracker/gem_version"

data/lib/danger_plugin.rb

@@ -0,0 +1,3 @@
+# frozen_string_literal: true
+
+require "pivotal_tracker/plugin"

data/lib/pivotal_tracker/gem_version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module PivotalTracker
+  VERSION = "0.0.2"
+end

data/lib/pivotal_tracker/plugin.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module Danger
+  # This is your plugin class. Any attributes or methods you expose here will
+  # be available from within your Dangerfile.
+  #
+  # To be published on the Danger plugins site, you will need to have
+  # the public interface documented. Danger uses [YARD](http://yardoc.org/)
+  # for generating documentation from your plugin source, and you can verify
+  # by running `danger plugins lint` or `bundle exec rake spec`.
+  #
+  # @example Check the PR for pivotal tracker story ID's and, if found, post links in the comments.
+  #
+  #          check(key: "Delivered", project_id: "PROJECT_ID")
+  #
+  # @see  kevnm67/danger-pivotal_tracker
+  # @tags pivotal-tracker, pivotal
+  #
+  class DangerPivotalTracker < Plugin
+    # Checks PR for pivotal stories and post links to the PR comments.
+    #
+    # @param [Array] key
+    #         An array of story status's (e.g. Delivered, Finished, etc.)
+    #
+    # @param [String] project_id
+    #         The pivotal tracker project ID.
+    #
+    # @param [String] emoji
+    #         The emoji you want to display in the message.
+    #
+    # @param [Boolean] search_title
+    #         Option to evaluate the PR title for matching pivotal stories.
+    #
+    # @param [Boolean] search_commits
+    #         Option to evaluate commits for story matches.
+    #
+    # @param [Boolean] fail_on_warning
+    #         Option to fail danger if no stories are found
+    #
+    # @param [Boolean] report_missing
+    #         Option to report if no storues were found
+    #
+    # @return [void]
+    #
+    def check(key: "", project_id: "nil", emoji: ":link:", search_title: true, search_commits: false, fail_on_warning: false, report_missing: true)
+      url = "https://www.pivotaltracker.com/n/projects/#{project_id}/stories/"
+
+      throw Error("'key' missing - must supply an array of story ids") if key.nil?
+
+      pivotal_stories = find_pivotal_stories(key: key, search_title: search_title, search_commits: search_commits)
+
+      if !pivotal_stories.empty?
+        story_urls = pivotal_stories.map { |issue| link(href: ensure_url_ends_with_slash(url), issue: issue) }.join(", ")
+        message("#{emoji} #{story_urls}")
+      elsif report_missing
+        msg = "No story ID's were matched in the PR title or commit messages (e.g. [\#123])"
+
+        if fail_on_warning
+          fail(msg)
+        else
+          warn(msg)
+        end
+      end
+    end
+
+    # Attempts to find story ID's from PR metadata.
+    #
+    # @param key [Type] default: nil
+    # @param search_title [Type] default: true
+    # @param search_commits [Type] default: false
+    # @return [Type] Matches story ids.
+    def find_pivotal_stories(key: nil, search_title: true, search_commits: true)
+      keys = key.kind_of?(Array) ? key.join(" |") : key
+      story_key_regex_string = /(#{keys} )#(\d{6,})/i
+      regexp = Regexp.new(/#{story_key_regex_string}/)
+
+      matching_stories = []
+
+      if search_title
+        github.pr_title.gsub(regexp) do |match|
+          matching_stories << extract_id(match).first
+
+          puts "matches #{matching_stories}"
+        end
+      end
+
+      if search_commits
+        puts "git commits #{git.commits}"
+        git.commits.map do |commit|
+          commit.message.gsub(regexp) do |match|
+            matching_stories << extract_id(match).first
+          end
+        end
+      end
+
+      if matching_stories.empty?
+        github.pr_body.gsub(regexp) do |match|
+          matching_stories << extract_id(match).first
+        end
+      end
+
+      return matching_stories.uniq
+    end
+
+    private
+
+    # Extracts all numbers from a given string.
+    #
+    # @param str [String] String to evaluate.
+    # @return [String] Numberical string.
+    def extract_id(str)
+      str.to_s.scan(/\d+/)
+    end
+
+    # Adds a slash at the end of the url if needed.
+    #
+    # @param url [String] URL to evaluate.
+    # @return [String] URL ending with a slash.
+    def ensure_url_ends_with_slash(url)
+      return "#{url}/" unless url.end_with?("/")
+
+      return url
+    end
+
+    # Creates an HTML string to post to the PR comments.
+    #
+    # @param href [String] default: nil.
+    # @param issue [String] default: nil
+    # @return [String] HTML string linking to the story issue.
+    def link(href: nil, issue: nil)
+      return "<a href='#{href}#{issue}'>#{issue}</a>"
+    end
+  end
+end