danger-jira 0.6.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 6e814fdd90d673e94f5fd1c01babfebca57b337e
-  data.tar.gz: fbafb6db77c0cbaefe974e9185420c8783a934a6
+SHA256:
+  metadata.gz: 7287a448b908b4d6879ac9b84f23eca2d36d5d9dd054a0825f29ea710a7de426
+  data.tar.gz: d15208bc1856e2aca33a38f507b1d49b1dca882d21a3f7d8571b57b93ab29b3d
 SHA512:
-  metadata.gz: 75c425fc0e37f98c6d79443f60806e95f076e13fe8f16ba071502be7632c49aad3b382a2baf147590aefaadcd7c9f026e99c6e728a4a780edf358a5a082885e7
-  data.tar.gz: f1391bf30950a3501c7fb8335d6ce3cb1951e50523666279081689ab99e74b1e3c19002180e64301af5e4aea34d37e6fa1f2eb5fcf58436ecb84225d49f01b9a
+  metadata.gz: 86772d0e7840a1c448e5d94d2e5df3c8b5a73190a3d17b961686b4e054008d3c2094e4364c8fc7c474818f305e685e0b108baf28673080129bfec24a05ad9686
+  data.tar.gz: ccb68490a542b183a1cfa62ea8dca9dd20dee815eeadfc6c7ff2711c13181c7ac9c460ea40a19b4e9e7fc80e9f185bd4c1b03ec65c9317da949a00ea2ceb3c57

data/README.md

@@ -3,7 +3,7 @@
 [![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](LICENSE.txt)
 [![Gem](https://img.shields.io/gem/v/danger-jira.svg?style=flat)](https://rubygems.org/gems/danger-jira)
 
-A [Danger](https://github.com/danger/danger) plugin for that links JIRA issues to pull requests. Inspired by [danger-plugin-jira-issue](https://github.com/macklinu/danger-plugin-jira-issue)
+A [Danger](https://github.com/danger/danger) plugin for that links JIRA issues to pull requests for both GitHub and GitLab. Inspired by [danger-plugin-jira-issue](https://github.com/macklinu/danger-plugin-jira-issue)
 
 ## Installation
 
@@ -22,6 +22,8 @@ jira.check(
   url: "https://myjira.atlassian.net/browse",
   search_title: true,
   search_commits: false,
+  search_branch: false,
+  search_body: false,
   fail_on_warning: false,
   report_missing: true,
   skippable: true
@@ -51,7 +53,7 @@ With "KEY-123" in the PR title or PR body, Danger will comment with:
 
 ## Skipping
 
-You can skip danger checking for a JIRA issue by having `[no-jira]` in your title or PR body.
+You can skip danger checking for a JIRA issue by if `no-jira` is provided on the PR title, description or commits. `nojira` is also allowed on branch names.
 
 ## License
 

data/danger-jira.gemspec

@@ -21,8 +21,8 @@ Gem::Specification.new do |spec|
   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', '~> 2.4'
+  spec.add_development_dependency 'rake', '~> 13.0'
 
   # Testing support
   spec.add_development_dependency 'rspec', '~> 3.4'

data/lib/jira/gem_version.rb

@@ -1,3 +1,3 @@
 module Jira
-  VERSION = "0.6.0".freeze
+  VERSION = "0.9.0".freeze
 end

data/lib/jira/plugin.rb

@@ -26,6 +26,9 @@ module Danger
     # @param [Boolean] search_commits
     #         Option to search JIRA issues from commit messages
     #
+    # @param [Boolean] search_branch
+    #         Option to search JIRA issues from the name of the PR branch
+    #
     # @param [Boolean] fail_on_warning
     #         Option to fail danger if no JIRA issue found
     #
@@ -33,11 +36,11 @@ module Danger
     #         Option to report if no JIRA issue was found
     #
     # @param [Boolean] skippable
-    #         Option to skip the report if 'no-jira' is provided on the PR title, description or commits
+    #         Option to skip the report if 'no-jira' is provided on the PR title, description or commits. 'nojira' is also allowed on branch names.
     #
     # @return [void]
     #
-    def check(key: nil, url: nil, emoji: ":link:", search_title: true, search_commits: false, fail_on_warning: false, report_missing: true, skippable: true)
+    def check(key: nil, url: nil, emoji: ":link:", search_title: true, search_commits: false, search_branch: false, search_body: false, fail_on_warning: false, report_missing: true, skippable: true)
       throw Error("'key' missing - must supply JIRA issue key") if key.nil?
       throw Error("'url' missing - must supply JIRA installation URL") if url.nil?
 
@@ -46,14 +49,21 @@ module Danger
       jira_issues = find_jira_issues(
         key: key,
         search_title: search_title,
-        search_commits: search_commits
+        search_commits: search_commits,
+        search_branch: search_branch,
+        search_body: search_body
       )
 
       if !jira_issues.empty?
         jira_urls = jira_issues.map { |issue| link(href: ensure_url_ends_with_slash(url), issue: issue) }.join(", ")
         message("#{emoji} #{jira_urls}")
       elsif report_missing
-        msg = "This PR does not contain any JIRA issue keys in the PR title or commit messages (e.g. KEY-123)"
+       msg = error_message_for(
+          search_title,
+          search_commits,
+          search_branch,
+          search_body
+        )
         if fail_on_warning
           fail(msg)
         else
@@ -69,7 +79,16 @@ module Danger
       return github
     end
 
-    def find_jira_issues(key: nil, search_title: true, search_commits: false)
+    def error_message_for(search_title, search_commits, search_branch, search_body)
+      error_string = ""
+      error_string += ", title" if search_title
+      error_string += ", commit messages" if search_commits
+      error_string += ", branch name" if search_branch
+      error_string += ", body" if search_body
+      return "This PR does not contain any JIRA issue keys in the PR" + error_string[1..-1] + " (e.g. KEY-123)"
+    end
+
+    def find_jira_issues(key: nil, search_title: true, search_commits: false, search_branch: false, search_body: false)
       # Support multiple JIRA projects
       keys = key.kind_of?(Array) ? key.join("|") : key
       jira_key_regex_string = "((?:#{keys})-[0-9]+)"
@@ -91,7 +110,13 @@ module Danger
         end
       end
 
-      if jira_issues.empty?
+      if search_branch
+        vcs_host.branch_for_head.gsub(regexp) do |match|
+          jira_issues << match
+        end
+      end
+
+      if search_body
         vcs_host.pr_body.gsub(regexp) do |match|
           jira_issues << match
         end
@@ -100,8 +125,8 @@ module Danger
     end
 
     def should_skip_jira?(search_title: true)
-      # Consider first occurrence of 'no-jira'
-      regexp = Regexp.new("no-jira", true)
+      # Consider first occurrence of 'no-jira' or nojira
+      regexp = Regexp.new("(no-jira|nojira)", true)
 
       if search_title
         vcs_host.pr_title.gsub(regexp) do |match|
@@ -113,6 +138,10 @@ module Danger
         return true unless match.empty?
       end
 
+      vcs_host.branch_for_head.gsub(regexp) do |match|
+        return true unless match.empty?
+      end
+
       return false
     end
 

data/spec/jira_spec.rb

@@ -37,16 +37,54 @@ module Danger
         expect(issues).to eq(["WEB-125"])
       end
 
+      it "can find jira issues via branch name" do
+        allow(@jira).to receive_message_chain("github.branch_for_head").and_return("bugfix/WEB-126")
+        issues = @jira.find_jira_issues(
+          key: "WEB",
+          search_title: false,
+          search_commits: false,
+          search_branch: true
+        )
+        expect(issues).to eq(["WEB-126"])
+      end
+
       it "can find jira issues in pr body" do
         allow(@jira).to receive_message_chain("github.pr_body").and_return("[WEB-126]")
         issues = @jira.find_jira_issues(
           key: "WEB",
           search_title: false,
-          search_commits: false
+          search_commits: false,
+          search_branch: false,
+          search_body: true
         )
         expect(issues).to eq(["WEB-126"])
       end
 
+      it "outputs error message for title" do
+        error_string = @jira.error_message_for(true, false, false, false)
+        expect(error_string).to eq("This PR does not contain any JIRA issue keys in the PR title (e.g. KEY-123)")
+      end
+
+      it "outputs error message for title, commits" do
+        error_string = @jira.error_message_for(true, true, false, false)
+        expect(error_string).to eq("This PR does not contain any JIRA issue keys in the PR title, commit messages (e.g. KEY-123)")
+      end
+
+      it "outputs error message for title, commits, branch" do
+        error_string = @jira.error_message_for(true, true, true, false)
+        expect(error_string).to eq("This PR does not contain any JIRA issue keys in the PR title, commit messages, branch name (e.g. KEY-123)")
+      end
+
+      it "outputs error message for title, commits, branch, body" do
+        error_string = @jira.error_message_for(true, true, true, true)
+        expect(error_string).to eq("This PR does not contain any JIRA issue keys in the PR title, commit messages, branch name, body (e.g. KEY-123)")
+      end
+
+      it "outputs error message for title, branch" do
+        error_string = @jira.error_message_for(true, false, true, false)
+        expect(error_string).to eq("This PR does not contain any JIRA issue keys in the PR title, branch name (e.g. KEY-123)")
+      end
+
       it "can find no-jira in pr body" do
         allow(@jira).to receive_message_chain("github.pr_body").and_return("[no-jira] Ticket doesn't need a jira but [WEB-123] WEB-123")
         result = @jira.should_skip_jira?(search_title: false)
@@ -59,6 +97,32 @@ module Danger
         expect(result).to be(true)
       end
 
+      it "can find no-jira in branch name" do
+        allow(@jira).to receive_message_chain("github.pr_body").and_return("")
+        allow(@jira).to receive_message_chain("github.branch_for_head").and_return("feat/no-jira/somefeature")
+        result = @jira.should_skip_jira?(search_title: false)
+        expect(result).to be(true)
+      end
+
+      it "can find nojira in pr body" do
+        allow(@jira).to receive_message_chain("github.pr_body").and_return("[nojira] Ticket doesn't need a jira but [WEB-123] WEB-123")
+        result = @jira.should_skip_jira?(search_title: false)
+        expect(result).to be(true)
+      end
+
+      it "can find nojira in title" do
+        allow(@jira).to receive_message_chain("github.pr_title").and_return("[nojira] Ticket doesn't need jira but [WEB-123] and WEB-123")
+        result = @jira.should_skip_jira?
+        expect(result).to be(true)
+      end
+
+      it "can find nojira in branch name" do
+        allow(@jira).to receive_message_chain("github.pr_body").and_return("")
+        allow(@jira).to receive_message_chain("github.branch_for_head").and_return("feat/nojira/somefeature")
+        result = @jira.should_skip_jira?(search_title: false)
+        expect(result).to be(true)
+      end
+
       it "can remove duplicates" do
         allow(@jira).to receive_message_chain("github.pr_title").and_return("Ticket [WEB-123] and WEB-123")
         issues = @jira.find_jira_issues(key: "WEB")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-jira
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.9.0
 platform: ruby
 authors:
 - RestlessThinker
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-04-16 00:00:00.000000000 Z
+date: 2023-10-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -30,28 +30,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.3'
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -176,7 +176,7 @@ homepage: https://github.com/RestlessThinker/danger-jira
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -191,9 +191,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
-signing_key: 
+rubygems_version: 3.4.10
+signing_key:
 specification_version: 4
 summary: A Danger plugin to link JIRA issues to a pull request.
 test_files: