danger-jira 0.4.2 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2b60d918d9064f2dcba7770ed3af01a9d004c56a
-  data.tar.gz: 2e68f7e4d194deea128895418831730ff58fd3e6
+  metadata.gz: daacac410e05a9b467387aebfd37ab246879df80
+  data.tar.gz: 2f8b2e3e28fe2b7fac647328296292e044faa768
 SHA512:
-  metadata.gz: 3a86f35dc9e1dc148f542814fda32b4e169d6f7b4fe3cb707a6e8dd4be1fddf54f95b44d6434f34929f700e986492e3a1d0cd9f56e2c7ec9845a612f675c327b
-  data.tar.gz: 6f09aacd48613a8a454bf6336e0d08373a1cdbdf627f81c7717eebbf3d2019c7a0de8f38dc846a2aeb6676424b83e74726cd84f5e02d7c672ab3dfefb196e962
+  metadata.gz: d2f031933e816a15720b421665f7f0c0f626e9da2270d6de76ad0780150142c3c323f11816bb8a602ef061930c6a53b25d45a1a70360012fc19885c5f177e9f6
+  data.tar.gz: 9d1f8d7c9910ff55c8bbd30d7bd5906e79e0c29ad6c2733dbd901acb2bb59f041adef5c2a4b05cd7b9d6046d82aa7092a75968f314edfa528321632a0aa76b12

data/README.md

@@ -20,10 +20,11 @@ gem 'danger-jira'
 jira.check(
   key: ["KEY", "PM"],
   url: "https://myjira.atlassian.net/browse",
-  search_title: true, 
-  search_commits: false, 
-  fail_on_warning: false, 
-  report_missing: true
+  search_title: true,
+  search_commits: false,
+  fail_on_warning: false,
+  report_missing: true,
+  skipabble: true
 )
 ```
 
@@ -48,6 +49,10 @@ With "KEY-123" in the PR title or PR body, Danger will comment with:
   Generated by :no_entry_sign: <a href="http://github.com/danger/danger/">Danger</a>
 </p>
 
+## Skipping
+
+You can skip danger checking for a JIRA issue by having `[no-jira]` in your title or PR body.
+
 ## License
 
 MIT

data/lib/jira/gem_version.rb

@@ -1,3 +1,3 @@
 module Jira
-  VERSION = "0.4.2".freeze
+  VERSION = "0.5.0".freeze
 end

data/lib/jira/plugin.rb

@@ -32,12 +32,17 @@ module Danger
     # @param [Boolean] report_missing
     #         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
+    #
     # @return [void]
     #
-    def check(key: nil, url: nil, emoji: ":link:", search_title: true, search_commits: false, fail_on_warning: false, report_missing: true)
+    def check(key: nil, url: nil, emoji: ":link:", search_title: true, search_commits: 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?
 
+      return if skippable && should_skip_jira?
+
       jira_issues = find_jira_issues(
         key: key,
         search_title: search_title,
@@ -89,6 +94,31 @@ module Danger
       return jira_issues.uniq
     end
 
+    def should_skip_jira?(search_title: true, search_commits: false)
+      # Consider first occurrence of 'no-jira'
+      regexp = Regexp.new("no-jira", true)
+
+      if search_title
+        github.pr_title.gsub(regexp) do |match|
+          return true unless match.empty?
+        end
+      end
+
+      if search_commits
+        git.commits.map do |commit|
+          commit.message.gsub(regexp) do |match|
+            return true unless match.empty?
+          end
+        end
+      end
+
+      github.pr_body.gsub(regexp) do |match|
+        return true unless match.empty?
+      end
+
+      return false
+    end
+
     def ensure_url_ends_with_slash(url)
       return "#{url}/" unless url.end_with?("/")
       return url

data/spec/jira_spec.rb

@@ -19,7 +19,7 @@ module Danger
       it "can find jira issues via title" do
         allow(@jira).to receive_message_chain("github.pr_title").and_return("Ticket [WEB-123] and WEB-124")
         issues = @jira.find_jira_issues(key: "WEB")
-        expect((issues <=> ["WEB-123", "WEB-124"]) == 0)
+        expect(issues).to eq(["WEB-123", "WEB-124"])
       end
 
       it "can find jira issues in commits" do
@@ -34,7 +34,7 @@ module Danger
           search_title: false,
           search_commits: true
         )
-        expect((issues <=> ["WEB-125"]) == 0)
+        expect(issues).to eq(["WEB-125"])
       end
 
       it "can find jira issues in pr body" do
@@ -44,13 +44,42 @@ module Danger
           search_title: false,
           search_commits: false
         )
-        expect((issues <=> ["WEB-126"]) == 0)
+        expect(issues).to eq(["WEB-126"])
+      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,
+          search_commits: false
+        )
+        expect(result).to be(true)
+      end
+
+      it "can find no-jira in commits" do
+        single_commit = Object.new
+        def single_commit.message
+          "Small text change [no-jira]"
+        end
+        commits = [single_commit]
+        allow(@jira).to receive_message_chain("git.commits").and_return(commits)
+        result = @jira.should_skip_jira?(
+          search_title: false,
+          search_commits: true
+        )
+        expect(result).to be(true)
+      end
+
+      it "can find no-jira in title" do
+        allow(@jira).to receive_message_chain("github.pr_title").and_return("[no-jira] Ticket doesn't need jira but [WEB-123] and WEB-123")
+        result = @jira.should_skip_jira?
+        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")
-        expect((issues <=> ["WEB-123"]) == 0)
+        expect(issues).to eq(["WEB-123"])
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-jira
 version: !ruby/object:Gem::Version
-  version: 0.4.2
+  version: 0.5.0
 platform: ruby
 authors:
 - RestlessThinker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-06 00:00:00.000000000 Z
+date: 2018-08-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api