danger-yajp 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17ad66f844e895f7e409c0576a5acb92cc040e19ae1aa1c5bb0e2cf2905bb144
-  data.tar.gz: 4f0f8c655b370ecfbdf3f180400a63ec4b1beff3e1acd48f9737381f88c0a096
+  metadata.gz: 31fe21c6c47db66193c9bb074710f559b03ea8b8df46abc478712d2d23d0d00d
+  data.tar.gz: 93cc2f58198a219c4a9e758c6e6ed2e36934dff6576b2d3d24ddca3e039e9698
 SHA512:
-  metadata.gz: b07a845fb824464a06a159419cf72580c7cd25867d18db56d61348dd097c42becfac016a9cc306648e42891d09a9ef66759a8c573dabf91fc92eb744f55f2b8f
-  data.tar.gz: 48363be1c7b1d43659268b0447c81d1ed0c994a8445f319f6c4cc3544862c98f5ef76e4413e4d39ad0eaf0cd1d333ba382d5d085c12f1162ec7623411178c3c7
+  metadata.gz: 278831d0fbef23988cd1fad62d056aab0bb21ce96b33215f6a0222c361c2d1860ecf6267da024a7b7cb7a0a68455e87df272ccc3768e1be8004f8c6b6887c88e
+  data.tar.gz: cc54f2f528a3a4c2a92f96330dad7116f30b667a6558262ffb4eedc07b10a9558490ba798229693fd8e8cc7d9c8331dbcbbd0e48f06cde3996bc2353a9c3418d

data/.rubocop.yml

@@ -4,6 +4,7 @@
 
 AllCops:
   TargetRubyVersion: 2.6
+  NewCops: enable
 
 Style/StringLiterals:
   EnforcedStyle: single_quotes

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    danger-yajp (0.0.2)
+    danger-yajp (0.1.0)
       danger-plugin-api
       jira-ruby
 
@@ -128,13 +128,13 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
     rspec-support (3.10.0)
-    rubocop (1.0.0)
+    rubocop (1.2.0)
       parallel (~> 1.10)
       parser (>= 2.7.1.5)
       rainbow (>= 2.2.2, < 4.0)
       regexp_parser (>= 1.8)
       rexml
-      rubocop-ast (>= 0.6.0)
+      rubocop-ast (>= 1.0.1)
       ruby-progressbar (~> 1.7)
       unicode-display_width (>= 1.4.0, < 2.0)
     rubocop-ast (1.1.1)
@@ -152,7 +152,7 @@ GEM
     tzinfo (1.2.7)
       thread_safe (~> 0.1)
     unicode-display_width (1.7.0)
-    webmock (3.9.3)
+    webmock (3.9.4)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
       hashdiff (>= 0.4.0, < 2.0.0)
@@ -170,7 +170,7 @@ DEPENDENCIES
   pry
   rake (~> 13.0)
   rspec (~> 3.9)
-  rubocop (~> 1.0.0)
+  rubocop (>= 1.0.0)
   webmock (~> 3.9)
   yard (~> 0.9.11)
 

data/README.md

@@ -1,6 +1,8 @@
 # Yet Another Jira Plugin
 
-[![License](http://img.shields.io/badge/license-MIT-green.svg?style=flat)](LICENSE)
+[![License](https://img.shields.io/github/license/juliendms/danger-yajp)](LICENSE)
+[![Gem](https://img.shields.io/gem/v/danger-yajp)](https://rubygems.org/gems/danger-yajp)
+[![Dependencies](https://img.shields.io/librariesio/release/rubygems/danger-yajp)](https://libraries.io/rubygems/danger-yajp)
 
 Yet Another Jira Plugin (in short: yajp) is a [Danger](https://danger.systems/ruby/) plugin that provides methods to easily find and manipulate issues from within the Dangerfile. The major difference with the existing Jira plugins is the ability to transition and update issues with the same feeling as manipulating PR data from Danger. This plugin was build in the same mind as Danger, meaning that you will find methods to easily manipulate Jira data, but no predefined warning and/or message.
 
@@ -57,6 +59,14 @@ The `transition` method only takes fields available in the transition screen. Us
 
 > Transition IDs can be found in Jira under Project Workflow > Edit Workflow in Text Mode.
 
+### Reference the PR as a remote link
+
+yajp can reference the PR as a remote link on Jira. It will use the icon of GitLab or Github depending on what you use. The remote link will use the URL of the PR as a `globalId` to not create duplicates. Optionnaly, you can specify the relationship with the issue (default is `relates to`), and the status, either as an object (eg. `{ "resolved": true, "icon": {...} }`) or as a boolean that will set the value of the property `resolved`. By default, no status is sent.
+
+```rb
+jira.pr_as_remotelink(issue, false)
+```
+
 ### Issue URL
 
 Use `issue_link` to retrieve the browse URL of the Jira issue.

data/danger-yajp.gemspec

@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock', '~> 3.9'
 
   # Linting code and docs
-  spec.add_development_dependency 'rubocop', '~> 1.0.0'
+  spec.add_development_dependency 'rubocop', '>= 1.0.0'
   spec.add_development_dependency 'yard', '~> 0.9.11'
 
   # Makes testing easy via `bundle exec guard`

data/lib/yajp/gem_version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Yajp
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
 end

data/lib/yajp/plugin.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require 'jira-ruby'
+require 'json'
 
 module Danger
   # Yet Another Jira Plugin (in short: yajp) provides methods to easily find and manipulate issues from within the Dangerfile.
@@ -69,9 +70,9 @@ module Danger
     #   jira.find_issues('KEY', search_title: false, search_branch: true)
     #
     # @param [Array<String>]  key An array of Jira project keys like `['KEY', 'JIRA']`, or a single `String` with a Jira project key
-    # @param [Boolean] search_title Option to search Jira issues from PR title, default `true`
-    # @param [Boolean] search_commits Option to search Jira issues from from commit messages, default `false`
-    # @param [Boolean] search_branch Option to search Jira issues from the name of the PR branch, default `false`
+    # @param [Boolean] search_title Option to search Jira issues from PR title
+    # @param [Boolean] search_commits Option to search Jira issues from from commit messages
+    # @param [Boolean] search_branch Option to search Jira issues from the name of the PR branch
     #
     # @return [Array<JIRA::Issue>] An array containing all the unique issues found in the PR.
     #
@@ -184,10 +185,40 @@ module Danger
     # @param [JIRA::Issue] issue
     #
     # @return [String] the URL of the issue
+    #
     def issue_link(issue)
       "#{ENV['DANGER_JIRA_URL']}/browse/#{issue.key}"
     end
 
+    # Add a remote link to the PR in the given Jira issues. It uses the link of the PR as the `globalId` of the remote link, thus avoiding to create duplicates each time the PR is updated.
+    #
+    # @param [Array<JIRA::Issue>] issue An array of issues, or a single `JIRA::Issue`
+    # @param [<String>] relation Option to set the relationship of the remote link
+    # @param [<Hash>] status Option to set the status property of the remote link, it can be <Hash> or a <Boolean> that will set the value of the property `resolved`
+    #
+    # @return [Boolean] `true` if all the remote links were added successfully, `false` otherwise.
+    #
+    def pr_as_remotelink(issue, relation: 'relates to', status: nil)
+      issues = issue.kind_of?(Array) ? issue : [] << issue
+      result = true
+
+      remote_link_prop = { object: { url: pr_link, title: vcs_host.pr_title, icon: link_icon } }
+      remote_link_prop[:globalId] = pr_link
+      remote_link_prop[:relationship] = relation
+
+      if status.kind_of?(Hash)
+        remote_link_prop[:object][:status] = status
+      elsif !status.nil?
+        remote_link_prop[:object][:status] = { resolved: status }
+      end
+
+      issues.each do |key|
+        result &= key.remotelink.build.save(remote_link_prop)
+      end
+
+      return result
+    end
+
     private
 
     def vcs_host
@@ -196,6 +227,26 @@ module Danger
       github
     end
 
+    def pr_link
+      return @pr_link unless @pr_link.nil?
+
+      pr_hash = JSON.parse(vcs_host.pr_json, symbolize_names: true)
+
+      if defined? @dangerfile.gitlab
+        @pr_link = pr_hash[:web_url]
+      else
+        @pr_link = pr_hash[:html_url]
+      end
+
+      return @pr_link
+    end
+
+    def link_icon
+      return { title: 'Gitlab', url16x16: 'https://gitlab.com/favicon.ico' } if defined? @dangerfile.gitlab
+
+      { title: 'Github', url16x16: 'https://github.com/favicon.ico' }
+    end
+
     def build_regexp_from_key(key)
       keys = key.kind_of?(Array) ? key.join('|') : key
       return /((?:#{keys})-[0-9]+)/

data/spec/support/remotelink.json

@@ -0,0 +1 @@
+{"object":{"url":"https://github.com/test/pull/1234","title":"PR Title","icon":{"title":"Github","url16x16":"https://github.com/favicon.ico"},"status":{"resolved":true}},"globalId":"https://github.com/test/pull/1234","relationship":"relates to"}

data/spec/yajp_spec.rb

@@ -2,6 +2,7 @@
 
 require_relative 'spec_helper'
 
+# rubocop:disable Metrics/ModuleLength
 module Danger
   describe Danger::DangerYajp do
     before do
@@ -72,6 +73,7 @@ module Danger
         expect(issues).to eq(['WEB-128', 'WEB-129'])
       end
 
+      # rubocop:disable Naming/VariableNumber
       it 'can split transition field from other fields' do
         json = File.read("#{File.dirname(__FILE__)}/support/transitions.all.json")
         url = "#{ENV['DANGER_JIRA_URL']}/rest/api/2/issue/WEB-130/transitions"
@@ -116,6 +118,27 @@ module Danger
         expect(stub).to have_been_requested.twice
         expect(result).to be true
       end
+      # rubocop:enable Naming/VariableNumber
+
+      it 'can add remote link' do
+        pr_title = 'PR Title'
+        pr_json = '{"html_url":"https://github.com/test/pull/1234"}'
+        url = "#{ENV['DANGER_JIRA_URL']}/rest/api/2/issue/WEB-134/remotelink"
+        json = File.read("#{File.dirname(__FILE__)}/support/remotelink.json")
+        issue = plugin.api.Issue.build
+
+        allow(issue).to receive(:key_value).and_return('WEB-134')
+        allow(dangerfile.github).to receive(:pr_json).and_return(pr_json)
+        allow(dangerfile.github).to receive(:pr_title).and_return(pr_title)
+
+        stub = stub_request(:post, url).
+          with(body: json)
+        result = plugin.pr_as_remotelink(issue, status: true)
+
+        expect(stub).to have_been_requested.once
+        expect(result).to be true
+      end
     end
   end
 end
+# rubocop:enable Metrics/ModuleLength

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: danger-yajp
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - juliendms
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-11-05 00:00:00.000000000 Z
+date: 2020-11-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: danger-plugin-api
@@ -98,14 +98,14 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.0.0
 - !ruby/object:Gem::Dependency
@@ -187,6 +187,7 @@ files:
 - lib/yajp/gem_version.rb
 - lib/yajp/plugin.rb
 - spec/spec_helper.rb
+- spec/support/remotelink.json
 - spec/support/transitions.all.json
 - spec/yajp_spec.rb
 homepage: https://github.com/juliendms/danger-yajp
@@ -215,5 +216,6 @@ summary: Yet Another Jira Plugin is a danger plugin to find issues, access their
   and perform operations on them.
 test_files:
 - spec/spec_helper.rb
+- spec/support/remotelink.json
 - spec/support/transitions.all.json
 - spec/yajp_spec.rb