danger-jira_issue_links 0.1.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7d151d73a8eac57249babc5e48eea8e6c0b8b663
-  data.tar.gz: 7564bb19da99d6e3ccaf2c84476750c05d56ec46
+  metadata.gz: 7e7df6fd19328c5200bca36fec3455702a803160
+  data.tar.gz: 7bf77af3efcb8d63e3660b397a0b208644df16d7
 SHA512:
-  metadata.gz: 5039cae3189e6ee329ce0722f949363fa151e330b55b47c7f59be27bc8c0f219fab5ded6f351aed6c4429cce3aa6e5d8549d022380d3bbde18914cd04db81046
-  data.tar.gz: da1ab3a2de0b2f320fde292948100c382936f1e1b442cda90f59857b7831de7a12b73aabb3196e50589e869dc1d5cb49753f35a3c90a9c40030da99ca68bf65a
+  metadata.gz: ddf477f291da157017bc91cd00d216bce118e79af1b004c7b49e3f6daa7dcd0bffab9f356d3f13fc778b9061c4e7aec0113f8ec538632c383103a2f5505c8890
+  data.tar.gz: 17372b48036608c53097dcd0cb7217f7e2c073f2c70dcd532e6d8f14bebf1d510eb94238cd653347b27171050a65fe31565cf73d7e01e9e13855d8f7fb853a97

data/.rspec

@@ -0,0 +1,3 @@
+--require spec_helper
+--color
+--format d

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-jira_issue_links (0.1.0)
+    danger-jira_issue_links (0.1.1)
       danger-plugin-api (~> 1.0)
       jira-ruby (~> 1.1)
 
@@ -13,7 +13,7 @@ GEM
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-    addressable (2.5.2)
+    addressable (2.6.0)
       public_suffix (>= 2.0.2, < 4.0)
     ast (2.4.0)
     claide (1.0.2)
@@ -26,13 +26,13 @@ GEM
     concurrent-ruby (1.1.5)
     cork (0.3.0)
       colored2 (~> 3.1)
-    danger (6.0.6)
+    danger (6.0.9)
       claide (~> 1.0)
       claide-plugins (>= 0.9.2)
       colored2 (~> 3.1)
       cork (~> 0.1)
       faraday (~> 0.9)
-      faraday-http-cache (~> 1.0)
+      faraday-http-cache (~> 2.0)
       git (~> 1.5)
       kramdown (~> 2.0)
       kramdown-parser-gfm (~> 1.0)
@@ -44,7 +44,7 @@ GEM
     diff-lcs (1.3)
     faraday (0.15.4)
       multipart-post (>= 1.2, < 3)
-    faraday-http-cache (1.3.1)
+    faraday-http-cache (2.0.0)
       faraday (~> 0.8)
     ffi (1.10.0)
     formatador (0.2.5)
@@ -71,7 +71,7 @@ GEM
       multipart-post
       oauth (~> 0.5, >= 0.5.0)
     kramdown (2.1.0)
-    kramdown-parser-gfm (1.0.1)
+    kramdown-parser-gfm (1.1.0)
       kramdown (~> 2.0)
     listen (3.0.7)
       rb-fsevent (>= 0.9.3)
@@ -79,7 +79,7 @@ GEM
     lumberjack (1.0.13)
     method_source (0.9.2)
     minitest (5.11.3)
-    multipart-post (2.0.0)
+    multipart-post (2.1.1)
     nap (1.1.0)
     nenv (0.3.0)
     no_proxy_fix (0.1.2)
@@ -97,7 +97,7 @@ GEM
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
     psych (3.1.0)
-    public_suffix (3.0.3)
+    public_suffix (3.1.0)
     rainbow (3.0.0)
     rake (10.5.0)
     rb-fsevent (0.10.3)
@@ -125,9 +125,9 @@ GEM
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 1.6)
     ruby-progressbar (1.10.0)
-    sawyer (0.8.1)
-      addressable (>= 2.3.5, < 2.6)
-      faraday (~> 0.8, < 1.0)
+    sawyer (0.8.2)
+      addressable (>= 2.3.5)
+      faraday (> 0.8, < 2.0)
     shellany (0.0.1)
     terminal-table (1.8.0)
       unicode-display_width (~> 1.1, >= 1.1.1)

data/README.md

@@ -33,6 +33,12 @@ jira_issue_links.jira_password = "password"
 jira_issue_links.jira_site = "https://your-company.atlassian.net"
 ```
 
+Option to include in output report phrase `Resolves TASK-123`, it help GitLab Jira plugin automatically close issues (see: [GitLab Jira integration](https://docs.gitlab.com/ee/user/project/integrations/jira.html#closing-jira-issues)).
+```
+jira_issue_links.include_resolves_keyword = true
+```
+
+
 Find all issue mentions in commit messages, obtain info from Jira and make table of links
 ```
 jira_issue_links.print_links_with_titles

data/lib/jira_issue_links/gem_version.rb

@@ -1,3 +1,3 @@
 module JiraIssueLinks
-  VERSION = "0.1.1".freeze
+  VERSION = "0.2.0".freeze
 end

data/lib/jira_issue_links/plugin.rb

@@ -18,6 +18,9 @@ module Danger
   #
   class DangerJiraIssueLinks < Plugin
 
+    # Private struct 
+    JiraIssue = Struct.new("JiraIssue", :id, :summary, :issuetype, :iconUrl)
+
     # Jira username
     #
     # @return   [String]
@@ -39,19 +42,21 @@ module Danger
     # @return   [String]
     attr_accessor :jira_context_path
 
+    # If `true` then in report will be added "Resolves" keyword for automatic resolve issue in jira. 
+    # @see https://docs.gitlab.com/ee/user/project/integrations/jira.html
+    # Default - false
+    #
+    # @return   [Bool]
+    attr_accessor :include_resolves_keyword
 
     # Find all issue references in commit messages.
     # Message should starts with pattern: `[TASK-123]`
     # @return   [Array<String>]
     def collect_issues_from_commits 
-      all_issues = []
-      git.commits.each do |c|
-          captures = c.message.match(/^\[(\w+-\d+)\]*./)&.captures
-          if captures
-            all_issues.push(captures[0])
-          end
-      end
-      all_issues.uniq
+      git.commits
+         .flat_map { |c| c.message.match(/^\[(\w+-\d+)\]/)&.captures }
+         .compact
+         .uniq
     end
 
     # Generates a `markdown` table of issues with type, title and link.
@@ -62,27 +67,26 @@ module Danger
       found_issues = collect_issues_from_commits
       return if found_issues.empty?
 
-      jira_context_path = '' if jira_context_path.nil?
-      client = JIRA::Client.new(
-          username:     jira_username,
-          password:     jira_password,
-          site:         jira_site,
-          context_path: jira_context_path,
-          auth_type:    :basic
-      )
-
       message = "## Jira issues\n\n"
-      message << "| | |\n"
-      message << "| --- | ----- |\n"
+      if include_resolves_keyword
+        message << "| | | |\n"
+        message << "| --- | --- | ----- |\n"
+      else 
+        message << "| | |\n"
+        message << "| --- | ----- |\n"
+      end
 
       begin
         found_issues.each do |issue_id| 
-          issue = client.Issue.jql("ID = '#{issue_id}'").first
+          issue = obtain_issue(issue_id)
           return if issue.nil?
           description = issue.summary
           description = description.gsub(/[<|>\[\]]/) { |bracket| "\\#{bracket}" }
-          message << "![#{issue.issuetype.name}](#{issue.issuetype.iconUrl}) | "
-          message << "[#{description}](#{jira_site}/browse/#{issue_id})\n" 
+          message << "![#{issue.issuetype}](#{issue.iconUrl}) | "
+          if include_resolves_keyword
+            message << "Resolves #{issue_id} | "
+          end
+          message << "[#{description}](#{jira_site}/browse/#{issue_id})\n"
         end
       rescue JIRA::HTTPError => e
         print e.message
@@ -100,13 +104,37 @@ module Danger
       found_issues = collect_issues_from_commits
       return if found_issues.empty?
 
-      message = "### Jira issues\n\n"
-      found_issues.each do |issue_id| 
-        message << "[#{issue_id}](#{jira_site}/browse/#{issue_id})\n\n" 
+      message = "## Jira issues\n\n"
+      found_issues.each do |issue_id|
+        if include_resolves_keyword
+          message << "Resolves "
+        end
+        message << "[#{issue_id}](#{jira_site}/browse/#{issue_id})\n\n"
       end
 
       markdown message
     end
 
+
+    private
+
+    def jira_client
+      jira_context_path = '' if jira_context_path.nil?
+      @jira_client = JIRA::Client.new(
+        username:     jira_username,
+        password:     jira_password,
+        site:         jira_site,
+        context_path: jira_context_path,
+        auth_type:    :basic
+      ) if @jira_client.nil?
+      return @jira_client
+    end
+
+    def obtain_issue(issue_id) 
+      issue = jira_client.Issue.jql("ID = '#{issue_id}'").first
+      return if issue.nil?
+      return JiraIssue.new(issue_id, issue.summary, issue.issuetype.name, issue.issuetype.iconUrl)
+    end
+
   end
 end

data/spec/jira_issue_links_spec.rb

@@ -2,6 +2,10 @@ require File.expand_path("../spec_helper", __FILE__)
 
 module Danger
   describe Danger::DangerJiraIssueLinks do
+
+    # alias
+    JiraIssue = Danger::DangerJiraIssueLinks::JiraIssue
+
     it "should be a plugin" do
       expect(Danger::DangerJiraIssueLinks.new(nil)).to be_a Danger::Plugin
     end
@@ -9,16 +13,80 @@ module Danger
     describe "with Dangerfile" do
       before do
         @dangerfile = testing_dangerfile
-        @my_plugin = @dangerfile.jira_issue_links
+        @plugin = @dangerfile.jira_issue_links
+      end
+
+      it "collect issues with regex" do 
+        @plugin.include_resolves_keyword = true
+
+        commits = [
+          "[XX-123] fix it",
+          "xxx",
+          "[XX-123] fix it",
+          "[A-1] fix it, [B-2] df"
+        ].map do |message|
+          instance_double('Commit', message: message)
+        end
+
+        expect(@plugin.git).to receive(:commits).and_return(commits)
+        expect(@plugin.collect_issues_from_commits).to eql([
+          "XX-123", "A-1"
+        ])
+
+      end
+
+      it "print simple links" do 
+        @plugin.jira_site = "http://site"
+
+        commits = [
+          "[XX-123] fix it"
+        ].map do |message|
+          instance_double('Commit', message: message)
+        end
+
+        expect(@plugin.git).to receive(:commits).and_return(commits)
+        expect(@plugin.print_links_only)
+        output = @plugin.status_report[:markdowns].first
+        expect(output.message).to eq("## Jira issues\n\n[XX-123](http://site/browse/XX-123)\n\n")
       end
+    
+
+      it "print jira task without resolves" do 
+        @plugin.jira_site = "http://site"
 
-      it "some" do
-        @my_plugin.print_links_only
+        commits = [
+          "[XX-123] fix it"
+        ].map do |message|
+          instance_double('Commit', message: message)
+        end
 
-        expect(@dangerfile.status_report[:warnings]).to eq([])
+        expect(@plugin.git).to receive(:commits).and_return(commits)
+        expect(@plugin).to receive(:obtain_issue).and_return(JiraIssue.new("XX-123", "summary", "Task", "url"))
+
+        expect(@plugin.print_links_with_titles)
+        output = @plugin.status_report[:markdowns].first
+        expect(output.message).to eq("## Jira issues\n\n| | |\n| --- | ----- |\n![Task](url) | [summary](http://site/browse/XX-123)\n")
       end
 
 
+      it "print jira task with resolves keyword" do 
+        @plugin.include_resolves_keyword = true
+        @plugin.jira_site = "http://site"
+
+        commits = [
+          "[XX-123] fix it"
+        ].map do |message|
+          instance_double('Commit', message: message)
+        end
+
+        expect(@plugin.git).to receive(:commits).and_return(commits)
+        expect(@plugin).to receive(:obtain_issue).and_return(JiraIssue.new("XX-123", "summary", "Task", "url"))
+
+        expect(@plugin.print_links_with_titles)
+        output = @plugin.status_report[:markdowns].first
+        expect(output.message).to eq("## Jira issues\n\n| | | |\n| --- | --- | ----- |\n![Task](url) | Resolves XX-123 | [summary](http://site/browse/XX-123)\n")
+      end
+
     end
   end
 end

data/spec/spec_helper.rb

@@ -51,7 +51,11 @@ def testing_env
   {
     "HAS_JOSH_K_SEAL_OF_APPROVAL" => "true",
     "DANGER_LOCAL_ONLY" => "true",
-    "FL_JIRA_SITE" => "https://redmadrobot.atlassian.net"
+    "FL_JIRA_SITE" => "https://redmadrobot.atlassian.net",
+    'TRAVIS_PULL_REQUEST' => '800',
+    'TRAVIS_REPO_SLUG' => 'artsy/eigen',
+    'TRAVIS_COMMIT_RANGE' => '759adcbd0d8f...13c4dc8bb61d',
+    'DANGER_GITHUB_API_TOKEN' => '123sbdq54erfsd3422gdfio'
   }
 end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-jira_issue_links
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Anton Glezman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-24 00:00:00.000000000 Z
+date: 2019-05-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -172,6 +172,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".rubocop.yml"
 - ".travis.yml"
 - Gemfile