plan_my_stuff 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 69661ace546ff5f775e0e9fb5e4a153c3aca9e68da0b568e85238d8b66ef620a
-  data.tar.gz: e0698c727fe6c3f1e8e135d0a2b1860731188dc01496065e3622a0a1d6ef0c45
+  metadata.gz: c4ce40c49bbe2d0ef870cf9983a5571631bdcce7f3ce52c31d5cf9885b143e3b
+  data.tar.gz: 8e62775d14932c50fe1b69cf76990345adf697dbdf509603eb7d5b4e35cc982f
 SHA512:
-  metadata.gz: 876ac7c9c1baf371e09d81535324ae9a35bcd1c3a30509931395e274a229fcf25397ba1377450cb6a8ad6465f0474174ea664579b59f0d407c9b83ee08523647
-  data.tar.gz: 89c4a1865f38c614c05d802c02d267b0ff2e83339da936403fac08f3d98476a6b87b722eecf422b5ee8f101f5db1ce75e8d3f836a3f54dd0ca86713df3146feb
+  metadata.gz: cf7fcd9a19a7845293c4b52f69ac7ef0cd9aa966bd0ddeb8851521d842e21f98a6e8ef49996125044bc453d99336ea086852d2d605951d348052a3ce16d2f250
+  data.tar.gz: 9f30fdb98fd6977eeb4362fe41f99472b4771299fa123a080bc83900c65bb794f69f19d5cdb1642efb4867435413ce01169014555641264896b1465b54dc6952

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.7.0
+
+### Added
+
+- `Issue#user_link` returns the per-issue URL in the consuming app, computed from `config.issues_url_prefix` + issue number
+
+### Changed
+
+- GitHub issues created/updated by PMS now render a markdown link `[Org/Repo#number](user_link)` as the visible body (previously empty); skipped when `issues_url_prefix` is unset
+
 ## 0.6.0
 
 ### Breaking

data/lib/generators/plan_my_stuff/install/templates/initializer.rb

@@ -93,8 +93,12 @@ PMS.configure do |config|
   # --------------------------------------------------------------------------
   # URL prefix
   # --------------------------------------------------------------------------
-  # Prefix for building user-facing ticket URLs in your app.
-  # config.issues_url_prefix = 'https://myapp.example.com/tickets/'
+  # Prefix for building user-facing ticket URLs in your app. The issue
+  # number is appended to form `Issue#user_link`, which the gem also
+  # writes as the visible body of the GitHub issue.
+  # Recommended default:
+  #   config.issues_url_prefix =
+  #     "#{Rails.application.config.action_mailer.default_url_options[:host]}/issues"
 
   # --------------------------------------------------------------------------
   # Request gateway

data/lib/plan_my_stuff/issue.rb

@@ -82,6 +82,17 @@ module PlanMyStuff
         number = read_field(result, :number)
         store_etag_to_cache(client, resolved_repo, number, result, cache_writer: :write_issue)
 
+        link_body = visible_body_for(number, resolved_repo)
+        if link_body.present?
+          result = client.rest(
+            :update_issue,
+            resolved_repo,
+            number,
+            body: MetadataParser.serialize(issue_metadata.to_h, link_body),
+          )
+          store_etag_to_cache(client, resolved_repo, number, result, cache_writer: :write_issue)
+        end
+
         issue = find(number, repo: resolved_repo)
 
         if add_to_project.present?
@@ -147,7 +158,7 @@ module PlanMyStuff
         case metadata
         when PlanMyStuff::IssueMetadata
           metadata.validate_custom_fields!
-          options[:body] = MetadataParser.serialize(metadata.to_h, '')
+          options[:body] = MetadataParser.serialize(metadata.to_h, visible_body_for(number, resolved_repo))
         when Hash
           current = client.rest(:issue, resolved_repo, number)
           current_body = current.respond_to?(:body) ? current.body : current[:body]
@@ -162,7 +173,7 @@ module PlanMyStuff
             merged_custom_fields,
           ).validate!
 
-          options[:body] = MetadataParser.serialize(existing_metadata, '')
+          options[:body] = MetadataParser.serialize(existing_metadata, visible_body_for(number, resolved_repo))
         end
 
         update_body_comment(number, resolved_repo, body) if body
@@ -235,6 +246,26 @@ module PlanMyStuff
 
       private
 
+        # Builds the visible body string written to GitHub for an issue:
+        # a markdown link to the consuming-app per-issue URL (carrying
+        # the repo as a +?repo=+ query param so the consuming app knows
+        # which repo this issue lives in), labelled with the GitHub
+        # +Org/Repo#number+. Returns +""+ when either
+        # +config.issues_url_prefix+ or +number+ is missing.
+        #
+        # @param number [Integer]
+        # @param repo [String] full repo path, e.g. +"BrandsInsurance/Element"+
+        #
+        # @return [String]
+        #
+        def visible_body_for(number, repo)
+          prefix = PlanMyStuff.configuration.issues_url_prefix
+          return '' if prefix.blank? || number.blank?
+
+          url = "#{prefix.to_s.chomp('/')}/#{number}?repo=#{URI.encode_www_form_component(repo)}"
+          "[#{repo}##{number}](#{url})"
+        end
+
         # Hydrates an Issue from a GitHub API response.
         #
         # @param github_issue [Object] Octokit issue response
@@ -298,6 +329,20 @@ module PlanMyStuff
       @body_dirty = true
     end
 
+    # @return [String, nil] per-issue URL in the consuming app
+    #   (+config.issues_url_prefix+ + +"/"+ + +number+ + +"?repo=Org/Repo"+,
+    #   or +nil+ when either prefix or number is missing). Also rendered
+    #   as the destination of the markdown link in the GitHub issue body.
+    def user_link
+      prefix = PlanMyStuff.configuration.issues_url_prefix
+      return if prefix.blank? || number.blank?
+
+      base = "#{prefix.to_s.chomp('/')}/#{number}"
+      return base if repo.blank?
+
+      "#{base}?repo=#{URI.encode_www_form_component(repo.full_name)}"
+    end
+
     # @return [Array<PlanMyStuff::Approval>] all required approvers (pending + approved)
     def approvers
       metadata.approvals

data/lib/plan_my_stuff/version.rb

@@ -3,7 +3,7 @@
 module PlanMyStuff
   module VERSION
     MAJOR = 0
-    MINOR = 6
+    MINOR = 7
     TINY = 0
 
     # Set PRE to nil unless it's a pre-release (beta, rc, etc.)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plan_my_stuff
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Brands Insurance