plan_my_stuff 0.17.0 → 0.18.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fe4f92dc92eca010b6fc7f53f4ce7701c6852420c9a537fdf0902e591c3309ad
-  data.tar.gz: b167fd42a3b5a37fc897bebf8f3696ed2cd863ac7049359445a329d9a7861988
+  metadata.gz: bded03d75c7bd996c62c647b038a588a4286628e7f041e385d4464ea87955505
+  data.tar.gz: 5b778d271d85a1ad5681d8617dec41875d5664d0c3ea861ab9421bef962de4d2
 SHA512:
-  metadata.gz: 746332e19a507f81dc0ee902a87664dcb0a55e3170d688d878b14faf508bfb67cc5dd3236a4961c6b15768fd47e7489b6b0cdbe5bdd5d328bcf9836f805d561d
-  data.tar.gz: 26a20b3318c99f34360bba90eee5698242f4043043991bf53d59e55b2507516452a5094c14366b19f6f53a140ff0b8a41f326a7048c13c4077f447eb2a083513
+  metadata.gz: db446cfa7623c4091f67cecd89ab7dfe84207237e601fd53f4a73401fc02d2019072801c326d281febb54373817cb87d35c60e2929a2ec425f1aca3e7623ef49
+  data.tar.gz: b7f4328f697271829202ee201f4c05a9e1553bc95d50b721cfc3132462c0401428b87e22bd79cdeb4962e249bea991b3f5d39cab9cb1a3c048ef13a647e31312

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 0.18.0
+
+### Breaking
+
+- `PMS::Issue#to_param` now returns `"Nickname-number"` (e.g. `"Rawr-1234"`) instead of the default ActiveModel id.
+  Single-issue URLs change from `/issues/1234?repo=rawr` to `/issues/Rawr-1234`. Consuming apps using
+  `youtrack_issue_path(@issue)` work natively; any hand-rolled URLs that passed `@issue.number` plus a `repo:`
+  query param must switch to `@issue` (or `@issue.to_param`). The mounted engine's controllers and views have
+  been updated to the new shape, as has the markdown link embedded in the GitHub issue body via
+  `Issue#user_link`.
+
+### Added
+
+- `config.repo_nicknames` (default `{}`) -- Symbol-keyed map from repo key to the human-readable label used as
+  the `Issue#to_param` prefix. Missing keys fall back to `key.to_s.titleize`, so `:rawr` -> `"Rawr"` is free;
+  only divergent ones (e.g. `safety: 'Compliance'`) need an entry.
+- `Configuration#repo_nickname_for(key)` accessor, `Repo#nickname`, and `Repo.from_nickname!` for the inverse
+  lookup used by `Issue.from_param`.
+- `Issue#to_param` and `Issue.from_param` -- the latter parses `"Nickname-1234"` back into `[Repo, Integer]`.
+- `Issue.find` first arg now accepts a nickname-id String (e.g. `"Rawr-1234"`) in addition to Integer / digit-
+  String + `repo:` kwarg. The nickname form ignores `repo:`.
+
 ## 0.17.0
 
 ### Added

data/CONFIGURATION.md

@@ -37,13 +37,17 @@ config.organization = 'YourOrg'
 |---|---|---|---|
 | `repos` | `Hash{Symbol => String}` | `{}` | Named repo configs mapping a key to an `Org/Repo` string. |
 | `default_repo` | `Symbol, nil` | `nil` | Repo key used when callers omit the `repo:` param. |
+| `repo_nicknames` | `Hash{Symbol => String}` | `{}` | `Issue#to_param` prefix override (default `key.titleize`). |
 
 ```ruby
 config.repos = { element: 'YourOrg/Element', underwriter: 'YourOrg/Underwriter' }
 config.default_repo = :element
+config.repo_nicknames = { safety: 'Compliance' } # :element -> "Element", :underwriter -> "Underwriter" come free
 ```
 
-`repos` can be mutated via `config.repos[:key] = '...'` or set via `config.repos = { key: 'MyOrg/MyRepo' }`
+`repos` can be mutated via `config.repos[:key] = '...'` or set via `config.repos = { key: 'MyOrg/MyRepo' }`.
+`Issue#to_param` then returns `"Element-1234"` / `"Compliance-567"`, encoding both repo and number in a single
+URL segment so `youtrack_issue_path(@issue)` works without a `repo:` query param.
 
 ## Projects
 

data/app/controllers/plan_my_stuff/comments_controller.rb

@@ -4,7 +4,7 @@ module PlanMyStuff
   class CommentsController < PlanMyStuff::ApplicationController
     # POST /issues/:issue_id/comments
     def create
-      @issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+      @issue = PlanMyStuff::Issue.find(params[:issue_id])
 
       PlanMyStuff::Comment.create!(
         issue: @issue,
@@ -15,11 +15,11 @@ module PlanMyStuff
       )
 
       flash[:success] = 'Comment was successfully created.'
-      redirect_to(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
+      redirect_to(plan_my_stuff.issue_path(@issue))
     rescue PlanMyStuff::LockedIssueError => e
       pms_handle_rescue(e)
       flash[:error] = 'This issue is locked; no new comments can be posted.'
-      redirect_to(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
+      redirect_to(plan_my_stuff.issue_path(@issue))
     end
 
     # GET /issues/:issue_id/comments/:id/edit
@@ -29,7 +29,7 @@ module PlanMyStuff
       return redirect_to_issue if issue_body_comment?
       return if can_edit?(@comment)
 
-      redirect_to_unauthorized(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
+      redirect_to_unauthorized(plan_my_stuff.issue_path(@issue))
     end
 
     # PATCH/PUT /issues/:issue_id/comments/:id
@@ -39,7 +39,7 @@ module PlanMyStuff
       return redirect_to_issue if issue_body_comment?
 
       unless can_edit?(@comment)
-        redirect_to_unauthorized(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
+        redirect_to_unauthorized(plan_my_stuff.issue_path(@issue))
 
         return
       end
@@ -50,7 +50,7 @@ module PlanMyStuff
       @comment.update!(**update_attrs, user: pms_current_user)
 
       flash[:success] = 'Comment was successfully updated.'
-      redirect_to(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
+      redirect_to(plan_my_stuff.issue_path(@issue))
     rescue PlanMyStuff::StaleObjectError => e
       pms_handle_rescue(e)
       flash.now[:error] = 'Comment was modified by someone else. Please review the latest changes and try again.'
@@ -69,7 +69,7 @@ module PlanMyStuff
       # @return [void]
       #
       def load_comment
-        @issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+        @issue = PlanMyStuff::Issue.find(params[:issue_id])
         @comment = PlanMyStuff::Comment.find(params[:id].to_i, issue: @issue)
       end
 
@@ -96,7 +96,7 @@ module PlanMyStuff
 
       # @return [void]
       def redirect_to_issue
-        redirect_to(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
+        redirect_to(plan_my_stuff.issue_path(@issue))
       end
   end
 end

data/app/controllers/plan_my_stuff/issues/approvals_controller.rb

@@ -23,7 +23,7 @@ module PlanMyStuff
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.request_approvals!(user_ids: user_ids, user: pms_current_user)
 
         flash[:success] = 'Approvers were successfully added.'
@@ -44,7 +44,7 @@ module PlanMyStuff
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
         caller_id = pms_current_user.present? ? PlanMyStuff::UserResolver.user_id(pms_current_user) : nil
 
         case status
@@ -85,7 +85,7 @@ module PlanMyStuff
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.remove_approvers!(user_ids: [params[:id].to_i], user: pms_current_user)
 
         flash[:success] = 'Approver was successfully removed.'
@@ -105,7 +105,7 @@ module PlanMyStuff
 
         # @return [String]
         def show_path
-          plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo])
+          plan_my_stuff.issue_path(params[:issue_id])
         end
     end
   end

data/app/controllers/plan_my_stuff/issues/closures_controller.rb

@@ -11,28 +11,28 @@ module PlanMyStuff
     class ClosuresController < PlanMyStuff::ApplicationController
       # POST /issues/:issue_id/closure
       def create
-        issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.update!(state: :closed)
 
         flash[:success] = 'Issue was successfully closed.'
-        redirect_to(plan_my_stuff.issue_path(issue.number, repo: issue.repo.full_name))
+        redirect_to(plan_my_stuff.issue_path(issue))
       rescue PlanMyStuff::Error, ArgumentError => e
         pms_handle_rescue(e)
         flash[:error] = e.message
-        redirect_to(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+        redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
       end
 
       # DELETE /issues/:issue_id/closure
       def destroy
-        issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.update!(state: :open)
 
         flash[:success] = 'Issue was successfully reopened.'
-        redirect_to(plan_my_stuff.issue_path(issue.number, repo: issue.repo.full_name))
+        redirect_to(plan_my_stuff.issue_path(issue))
       rescue PlanMyStuff::Error, ArgumentError => e
         pms_handle_rescue(e)
         flash[:error] = e.message
-        redirect_to(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+        redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
       end
     end
   end

data/app/controllers/plan_my_stuff/issues/links_controller.rb

@@ -21,38 +21,38 @@ module PlanMyStuff
       def create
         type = link_params[:type].to_s
         unless dispatch_allowed?(type, :add)
-          redirect_to_unauthorized(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+          redirect_to_unauthorized(plan_my_stuff.issue_path(params[:issue_id]))
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
         link = add_link(issue, type)
 
         flash[:success] = "Linked #{link}"
-        redirect_to(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+        redirect_to(plan_my_stuff.issue_path(issue))
       rescue PlanMyStuff::ValidationError, ActiveModel::ValidationError, ArgumentError => e
         pms_handle_rescue(e)
         flash[:error] = e.message
-        redirect_to(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+        redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
       end
 
       # DELETE /issues/:issue_id/links/:id
       def destroy
         type, repo, number = parse_composite_id(params[:id])
         unless dispatch_allowed?(type, :remove)
-          redirect_to_unauthorized(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+          redirect_to_unauthorized(plan_my_stuff.issue_path(params[:issue_id]))
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
         remove_link(issue, type, repo: repo, number: number)
 
         flash[:success] = "Unlinked #{repo}##{number}"
-        redirect_to(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+        redirect_to(plan_my_stuff.issue_path(issue))
       rescue PlanMyStuff::ValidationError, ActiveModel::ValidationError, ArgumentError => e
         pms_handle_rescue(e)
         flash[:error] = e.message
-        redirect_to(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+        redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
       end
 
       private

data/app/controllers/plan_my_stuff/issues/takes_controller.rb

@@ -11,37 +11,31 @@ module PlanMyStuff
 
       # POST /issues/:issue_id/take
       def create
-        issue_number = params[:issue_id].to_i
-        repo = params[:repo]
-
-        issue = PlanMyStuff::Issue.find(issue_number, repo: repo)
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
         guard_already_taken!(issue)
 
-        project_item = PlanMyStuff::Pipeline::IssueLinker.find_project_item(issue_number)
+        project_item = PlanMyStuff::Pipeline::IssueLinker.find_project_item(issue.number)
         project_item ||= add_to_pipeline(issue)
 
         PlanMyStuff::Pipeline.take!(project_item)
         assign_current_user(project_item)
-        flash[:success] ||= "Issue ##{issue_number} taken."
+        flash[:success] ||= "Issue ##{issue.number} taken."
 
-        redirect_to(plan_my_stuff.issue_path(issue_number, repo: repo))
+        redirect_to(plan_my_stuff.issue_path(issue))
       rescue ArgumentError, PlanMyStuff::Error => e
         pms_handle_rescue(e)
         flash[:error] = e.message
-        redirect_to(plan_my_stuff.issue_path(issue_number, repo: repo))
+        redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
       end
 
       # DELETE /issues/:issue_id/take
       def destroy
-        issue_number = params[:issue_id].to_i
-        repo = params[:repo]
-
-        issue = PlanMyStuff::Issue.find(issue_number, repo: repo)
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
         login = current_user_login
         guard_release!(issue, login)
 
         remaining = issue.assignees - [login]
-        project_item = PlanMyStuff::Pipeline::IssueLinker.find_project_item(issue_number)
+        project_item = PlanMyStuff::Pipeline::IssueLinker.find_project_item(issue.number)
 
         if project_item.present?
           if remaining.empty?
@@ -54,12 +48,12 @@ module PlanMyStuff
           issue.update!(assignees: remaining)
         end
 
-        flash[:success] = "Issue ##{issue_number} released."
-        redirect_to(plan_my_stuff.issue_path(issue_number, repo: repo))
+        flash[:success] = "Issue ##{issue.number} released."
+        redirect_to(plan_my_stuff.issue_path(issue))
       rescue ArgumentError, PlanMyStuff::Error => e
         pms_handle_rescue(e)
         flash[:error] = e.message
-        redirect_to(plan_my_stuff.issue_path(issue_number, repo: repo))
+        redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
       end
 
       private
@@ -72,7 +66,7 @@ module PlanMyStuff
           return if support_user?
 
           redirect_to_unauthorized(
-            plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]),
+            plan_my_stuff.issue_path(params[:issue_id]),
           )
         end
 

data/app/controllers/plan_my_stuff/issues/viewers_controller.rb

@@ -12,44 +12,44 @@ module PlanMyStuff
       # POST /issues/:issue_id/viewers
       def create
         unless support_user?
-          redirect_to_unauthorized(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+          redirect_to_unauthorized(plan_my_stuff.issue_path(params[:issue_id]))
           return
         end
 
         viewer_ids = parse_viewer_ids(params[:viewer_ids])
         if viewer_ids.blank?
           flash[:error] = 'No valid viewer IDs provided.'
-          redirect_to(plan_my_stuff.edit_issue_path(params[:issue_id], repo: params[:repo]))
+          redirect_to(plan_my_stuff.edit_issue_path(params[:issue_id]))
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.add_viewers!(user_ids: viewer_ids, user: pms_current_user)
 
         flash[:success] = 'Viewers were successfully added.'
-        redirect_to(plan_my_stuff.edit_issue_path(params[:issue_id], repo: params[:repo]))
+        redirect_to(plan_my_stuff.edit_issue_path(params[:issue_id]))
       rescue PlanMyStuff::Error, Octokit::Error => e
         pms_handle_rescue(e)
         flash[:error] = e.message
-        redirect_to(plan_my_stuff.edit_issue_path(params[:issue_id], repo: params[:repo]))
+        redirect_to(plan_my_stuff.edit_issue_path(params[:issue_id]))
       end
 
       # DELETE /issues/:issue_id/viewers/:id
       def destroy
         unless support_user?
-          redirect_to_unauthorized(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+          redirect_to_unauthorized(plan_my_stuff.issue_path(params[:issue_id]))
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.remove_viewers!(user_ids: [params[:id].to_i], user: pms_current_user)
 
         flash[:success] = 'Viewer was successfully removed.'
-        redirect_to(plan_my_stuff.edit_issue_path(params[:issue_id], repo: params[:repo]))
+        redirect_to(plan_my_stuff.edit_issue_path(params[:issue_id]))
       rescue PlanMyStuff::Error, Octokit::Error => e
         pms_handle_rescue(e)
         flash[:error] = e.message
-        redirect_to(plan_my_stuff.edit_issue_path(params[:issue_id], repo: params[:repo]))
+        redirect_to(plan_my_stuff.edit_issue_path(params[:issue_id]))
       end
     end
   end

data/app/controllers/plan_my_stuff/issues/waitings_controller.rb

@@ -12,37 +12,37 @@ module PlanMyStuff
       # POST /issues/:issue_id/waiting
       def create
         unless support_user?
-          redirect_to_unauthorized(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+          redirect_to_unauthorized(plan_my_stuff.issue_path(params[:issue_id]))
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.enter_waiting_on_user!(user: pms_current_user)
 
         flash[:success] = 'Issue marked as waiting on user reply.'
-        redirect_to(plan_my_stuff.issue_path(issue.number, repo: issue.repo.full_name))
+        redirect_to(plan_my_stuff.issue_path(issue))
       rescue PlanMyStuff::Error, ArgumentError => e
         pms_handle_rescue(e)
         flash[:error] = e.message
-        redirect_to(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+        redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
       end
 
       # DELETE /issues/:issue_id/waiting
       def destroy
         unless support_user?
-          redirect_to_unauthorized(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+          redirect_to_unauthorized(plan_my_stuff.issue_path(params[:issue_id]))
           return
         end
 
-        issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.clear_waiting_on_user!
 
         flash[:success] = 'Waiting-on-user state cleared.'
-        redirect_to(plan_my_stuff.issue_path(issue.number, repo: issue.repo.full_name))
+        redirect_to(plan_my_stuff.issue_path(issue))
       rescue PlanMyStuff::Error, ArgumentError => e
         pms_handle_rescue(e)
         flash[:error] = e.message
-        redirect_to(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+        redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
       end
     end
   end

data/app/controllers/plan_my_stuff/issues_controller.rb

@@ -34,7 +34,7 @@ module PlanMyStuff
       )
 
       flash[:success] = 'Issue was successfully created.'
-      redirect_to(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
+      redirect_to(plan_my_stuff.issue_path(@issue))
     rescue PlanMyStuff::ValidationError => e
       pms_handle_rescue(e)
       @issue = PlanMyStuff::Issue.new(title: issue_params[:title], body: issue_params[:body])
@@ -44,7 +44,7 @@ module PlanMyStuff
 
     # GET /issues/:id
     def show
-      @issue = PlanMyStuff::Issue.find(params[:id].to_i, repo: params[:repo])
+      @issue = PlanMyStuff::Issue.find(params[:id])
       @comments = filter_visible_comments(@issue.comments)
       @current_user_id = pms_current_user.present? ? PlanMyStuff::UserResolver.user_id(pms_current_user) : nil
       @current_user_login = PlanMyStuff.configuration.github_login_for[@current_user_id]
@@ -54,12 +54,12 @@ module PlanMyStuff
 
     # GET /issues/:id/edit
     def edit
-      @issue = PlanMyStuff::Issue.find(params[:id].to_i, repo: params[:repo])
+      @issue = PlanMyStuff::Issue.find(params[:id])
     end
 
     # PATCH/PUT /issues/:id
     def update
-      @issue = PlanMyStuff::Issue.find(params[:id].to_i, repo: params[:repo])
+      @issue = PlanMyStuff::Issue.find(params[:id])
 
       @issue.update!(
         title: issue_params[:title],
@@ -68,7 +68,7 @@ module PlanMyStuff
       )
 
       flash[:success] = 'Issue was successfully updated.'
-      redirect_to(plan_my_stuff.issue_path(@issue.number, repo: @issue.repo.full_name))
+      redirect_to(plan_my_stuff.issue_path(@issue))
     rescue PlanMyStuff::StaleObjectError => e
       pms_handle_rescue(e)
       flash.now[:error] = 'Issue was modified by someone else. Please review the latest changes and try again.'

data/app/controllers/plan_my_stuff/labels_controller.rb

@@ -7,40 +7,40 @@ module PlanMyStuff
       labels = parse_labels(params[:label_name])
       if labels.blank?
         flash[:error] = 'Label name is required.'
-        redirect_to(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+        redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
         return
       end
 
-      issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+      issue = PlanMyStuff::Issue.find(params[:issue_id])
 
       missing = labels.reject { |label| PlanMyStuff::Label.exists?(repo: issue.repo, name: label) }
       if missing.any?
         flash[:error] = "Label#{'s' if missing.size > 1} not found in repo: #{missing.join(', ')}"
-        redirect_to(plan_my_stuff.issue_path(issue.number, repo: issue.repo.full_name))
+        redirect_to(plan_my_stuff.issue_path(issue))
         return
       end
 
       PlanMyStuff::Label.add!(issue: issue, labels: labels)
 
       flash[:success] = 'Label was successfully added.'
-      redirect_to(plan_my_stuff.issue_path(issue.number, repo: issue.repo.full_name))
+      redirect_to(plan_my_stuff.issue_path(issue))
     rescue PlanMyStuff::Error, Octokit::Error => e
       pms_handle_rescue(e)
       flash[:error] = e.message
-      redirect_to(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+      redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
     end
 
     # DELETE /issues/:issue_id/labels/:id
     def destroy
-      issue = PlanMyStuff::Issue.find(params[:issue_id].to_i, repo: params[:repo])
+      issue = PlanMyStuff::Issue.find(params[:issue_id])
       PlanMyStuff::Label.remove!(issue: issue, labels: [params[:id]])
 
       flash[:success] = 'Label was successfully removed.'
-      redirect_to(plan_my_stuff.issue_path(issue.number, repo: issue.repo.full_name))
+      redirect_to(plan_my_stuff.issue_path(issue))
     rescue PlanMyStuff::Error, Octokit::Error => e
       pms_handle_rescue(e)
       flash[:error] = e.message
-      redirect_to(plan_my_stuff.issue_path(params[:issue_id], repo: params[:repo]))
+      redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
     end
   end
 end

data/app/views/plan_my_stuff/issues/index.html.erb

@@ -14,7 +14,7 @@
       <% @issues.each do |issue| %>
         <tr>
           <td><%= issue.number %></td>
-          <td><%= link_to(issue.title, plan_my_stuff.issue_path(issue.number, repo: issue.repo.full_name)) %></td>
+          <td><%= link_to(issue.title, plan_my_stuff.issue_path(issue)) %></td>
           <td><%= issue.state %></td>
           <td><%= issue.labels.join(', ') %></td>
         </tr>

data/app/views/plan_my_stuff/issues/partials/_approvals.html.erb

@@ -44,7 +44,7 @@
               <%=
                 button_to(
                   'Approve',
-                  plan_my_stuff.issue_approval_path(issue.number, approval.user_id, repo: issue.repo.full_name),
+                  plan_my_stuff.issue_approval_path(issue, approval.user_id),
                   method: :patch,
                   params: { approval: { status: 'approved' } },
                   form: { style: 'display:inline' },
@@ -53,7 +53,7 @@
               <%=
                 button_to(
                   'Reject',
-                  plan_my_stuff.issue_approval_path(issue.number, approval.user_id, repo: issue.repo.full_name),
+                  plan_my_stuff.issue_approval_path(issue, approval.user_id),
                   method: :patch,
                   params: { approval: { status: 'rejected' } },
                   form: { style: 'display:inline' },
@@ -65,7 +65,7 @@
               <%=
                 button_to(
                   'Revoke',
-                  plan_my_stuff.issue_approval_path(issue.number, approval.user_id, repo: issue.repo.full_name),
+                  plan_my_stuff.issue_approval_path(issue, approval.user_id),
                   method: :patch,
                   params: { approval: { status: 'pending' } },
                   form: { style: 'display:inline' },
@@ -77,7 +77,7 @@
               <%=
                 button_to(
                   'Remove',
-                  plan_my_stuff.issue_approval_path(issue.number, approval.user_id, repo: issue.repo.full_name),
+                  plan_my_stuff.issue_approval_path(issue, approval.user_id),
                   method: :delete,
                   form: { style: 'display:inline' },
                 )
@@ -94,7 +94,7 @@
       <%=
         form_with(
           scope: :approval,
-          url: plan_my_stuff.issue_approvals_path(issue.number, repo: issue.repo.full_name),
+          url: plan_my_stuff.issue_approvals_path(issue),
           method: :post,
           local: true,
         ) do |form|

data/app/views/plan_my_stuff/issues/partials/_form.html.erb

@@ -3,7 +3,7 @@
   persisted = issue.persisted?
   url =
     if persisted
-      plan_my_stuff.issue_path(issue.number, repo: issue.repo&.full_name)
+      plan_my_stuff.issue_path(issue)
     else
       plan_my_stuff.issues_path(repo: issue.repo&.full_name)
     end

data/app/views/plan_my_stuff/issues/partials/_links.html.erb

@@ -68,7 +68,7 @@
               <%=
                 link_to(
                   "#{target.repo.full_name}##{target.number} - #{target.title}",
-                  plan_my_stuff.issue_path(target.number, repo: target.repo.full_name),
+                  plan_my_stuff.issue_path(target),
                 )
               %>
               <% if section[:removable] %>
@@ -78,7 +78,7 @@
                 <%=
                   button_to(
                     'Remove',
-                    plan_my_stuff.issue_link_path(issue.number, link_id, repo: issue.repo.full_name),
+                    plan_my_stuff.issue_link_path(issue, link_id),
                     method: :delete,
                     form: { style: 'display:inline' },
                   )
@@ -95,7 +95,7 @@
         <%=
           form_with(
             scope: :link,
-            url: plan_my_stuff.issue_links_path(issue.number, repo: issue.repo.full_name),
+            url: plan_my_stuff.issue_links_path(issue),
             method: :post,
             local: true,
           ) do |form|

data/app/views/plan_my_stuff/issues/partials/_viewers.html.erb

@@ -10,7 +10,7 @@
         <%=
           button_to(
             'Remove',
-            plan_my_stuff.issue_viewer_path(issue.number, viewer_id, repo: issue.repo.full_name),
+            plan_my_stuff.issue_viewer_path(issue, viewer_id),
             method: :delete
           )
         %>
@@ -21,7 +21,7 @@
   <p>No viewers added.</p>
 <% end %>
 
-<%= form_with(url: plan_my_stuff.issue_viewers_path(issue.number, repo: issue.repo.full_name), method: :post) do |form| %>
+<%= form_with(url: plan_my_stuff.issue_viewers_path(issue), method: :post) do |form| %>
   <div>
     <%= form.label(:viewer_ids, 'Add viewer IDs (comma-separated)') %>
     <%= form.text_field(:viewer_ids) %>

data/app/views/plan_my_stuff/issues/show.html.erb

@@ -1,27 +1,27 @@
 <h1><%= @issue.title %> <small>#<%= @issue.number %></small></h1>
 
 <p>
-  <%= link_to('Edit', plan_my_stuff.edit_issue_path(@issue.number, repo: @issue.repo.full_name)) %>
+  <%= link_to('Edit', plan_my_stuff.edit_issue_path(@issue)) %>
   <% if @support_user && @issue.html_url.present? %>
     <%= link_to('View on GitHub', @issue.html_url, target: '_blank', rel: 'noopener') %>
   <% end %>
   <% if @issue.state == 'open' %>
-    <%= button_to('Close Issue', plan_my_stuff.issue_closure_path(@issue.number, repo: @issue.repo.full_name), method: :post) %>
+    <%= button_to('Close Issue', plan_my_stuff.issue_closure_path(@issue), method: :post) %>
   <% else %>
-    <%= button_to('Reopen Issue', plan_my_stuff.issue_closure_path(@issue.number, repo: @issue.repo.full_name), method: :delete) %>
+    <%= button_to('Reopen Issue', plan_my_stuff.issue_closure_path(@issue), method: :delete) %>
   <% end %>
   <% if @support_user && @issue.state == 'open' %>
     <% if @issue.metadata.waiting_on_user_at.present? %>
-      <%= button_to('Mark replied', plan_my_stuff.issue_waiting_path(@issue.number, repo: @issue.repo.full_name), method: :delete) %>
+      <%= button_to('Mark replied', plan_my_stuff.issue_waiting_path(@issue), method: :delete) %>
     <% else %>
-      <%= button_to('Mark waiting', plan_my_stuff.issue_waiting_path(@issue.number, repo: @issue.repo.full_name), method: :post) %>
+      <%= button_to('Mark waiting', plan_my_stuff.issue_waiting_path(@issue), method: :post) %>
     <% end %>
   <% end %>
   <% if @support_user && @pipeline_enabled && @pipeline_item.nil? && @issue.assignees.blank? %>
-    <%= button_to('Take', plan_my_stuff.issue_take_path(@issue.number, repo: @issue.repo.full_name), method: :post) %>
+    <%= button_to('Take', plan_my_stuff.issue_take_path(@issue), method: :post) %>
   <% end %>
   <% if @support_user && @pipeline_enabled && @current_user_login.present? && @issue.assignees.include?(@current_user_login) %>
-    <%= button_to('Unassign', plan_my_stuff.issue_take_path(@issue.number, repo: @issue.repo.full_name), method: :delete) %>
+    <%= button_to('Unassign', plan_my_stuff.issue_take_path(@issue), method: :delete) %>
   <% end %>
   <% if @support_user %>
     <%= link_to('Start Testing Project', plan_my_stuff.new_testing_project_path(subject_url: @issue.html_url)) %>
@@ -76,7 +76,7 @@
       <%= PlanMyStuff::Markdown.render(comment.body || '').html_safe %>
       <% if comment.pms_comment? && (@support_user || comment.metadata.created_by == @current_user_id) %>
         <p>
-          <%= link_to('Edit', plan_my_stuff.edit_issue_comment_path(@issue.number, comment.id, repo: @issue.repo.full_name)) %>
+          <%= link_to('Edit', plan_my_stuff.edit_issue_comment_path(@issue, comment.id)) %>
         </p>
       <% end %>
       <% if @support_user && comment.html_url.present? %>

data/app/views/plan_my_stuff/projects/show.html.erb

@@ -24,7 +24,9 @@
             <% items.each do |item| %>
               <div style="border: 1px solid black; margin: 1em">
                 <% unless item.draft? %>
-                  <strong><%= link_to(item.title, plan_my_stuff.issue_path(item.number, repo: item.repo.full_name)) %></strong>
+                  <strong>
+                    <%= link_to(item.title, plan_my_stuff.issue_path(item.issue.to_param)) %>
+                  </strong>
                 <% else %>
                   <strong><%= item.title %></strong>
                 <% end %>

data/app/views/plan_my_stuff/testing_projects/partials/_item.html.erb

@@ -3,7 +3,7 @@
   <% if item.draft? %>
     <strong><%= item.title %></strong>
   <% else %>
-    <strong><%= link_to(item.title, plan_my_stuff.issue_path(item.number, repo: item.repo.full_name)) %></strong>
+    <strong><%= link_to(item.title, plan_my_stuff.issue_path(item.issue.to_param)) %></strong>
     <small>#<%= item.number %></small>
   <% end %>
 

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

@@ -24,6 +24,12 @@ PlanMyStuff.configure do |config|
   # config.repos[:underwriter] = 'YourOrganization/Underwriter'
   # config.default_repo = :element
 
+  # Human-readable prefix used as the `Issue#to_param` so URLs read
+  # `/issues/Element-1234` instead of `/issues/1234`. Missing keys fall back
+  # to `key.to_s.titleize`; only repos whose key doesn't titleize cleanly
+  # need an entry.
+  # config.repo_nicknames = { safety: 'Compliance' }
+
   # --------------------------------------------------------------------------
   # Projects
   # --------------------------------------------------------------------------

data/lib/plan_my_stuff/configuration.rb

@@ -348,6 +348,14 @@ module PlanMyStuff
     #
     attr_accessor :repos
 
+    # Human-readable repo names used as the +to_param+ prefix on +PlanMyStuff::Issue+ instances. Symbol-keyed
+    # against +repos+ -- missing keys fall back to +key.to_s.titleize+, so only entries that diverge from a simple
+    # +titleize+ of the key (e.g. +:safety+ -> +"Compliance"+) need to be listed.
+    #
+    # @return [Hash{Symbol => String}]
+    #
+    attr_accessor :repo_nicknames
+
     # Bare repo name (under +config.organization+) that stores uploaded attachment binaries. Defaults to
     # +'pms-attachments'+. The repo must exist; the uploader does not create it. Attachments commit onto
     # +config.main_branch+ and live under +<repo_key_or_name>/issue-<number>/<uuid>.<ext>+.
@@ -368,6 +376,7 @@ module PlanMyStuff
     # @return [Configuration]
     def initialize
       @repos = {}
+      @repo_nicknames = {}
       @attachment_repo = 'pms-attachments'
       @user_class = 'User'
       @display_name_method = :to_s
@@ -435,12 +444,14 @@ module PlanMyStuff
       missing << 'access_token' if access_token.nil? || access_token.to_s.strip.empty?
       missing << 'organization' if organization.nil? || organization.to_s.strip.empty?
 
-      return if missing.empty?
+      if missing.present?
+        raise(
+          PlanMyStuff::ConfigurationError,
+          "Missing required PlanMyStuff configuration: #{missing.join(', ')}",
+        )
+      end
 
-      raise(
-        PlanMyStuff::ConfigurationError,
-        "Missing required PlanMyStuff configuration: #{missing.join(', ')}",
-      )
+      validate_repo_nicknames!
     end
 
     # Returns the merged custom fields schema for the given context. Context-specific fields deep-merge on top of
@@ -477,6 +488,51 @@ module PlanMyStuff
       path = controllers[key] || DEFAULT_CONTROLLERS.fetch(key)
       path.start_with?('/') ? path : "/#{path}"
     end
+
+    # Human-readable nickname for a repo key, used as the +to_param+ prefix on +PlanMyStuff::Issue+ instances. Falls
+    # back to +key.to_s.titleize+ when no explicit entry exists in +repo_nicknames+.
+    #
+    # @param key [Symbol, String]
+    #
+    # @return [String]
+    #
+    def repo_nickname_for(key)
+      repo_nicknames[key&.to_sym] || key.to_s.titleize
+    end
+
+    private
+
+      # Resolved nicknames feed directly into +Issue#to_param+ and route +:id+ tokens, so collisions or chars outside
+      # +[A-Za-z0-9_]+ (notably +-+, the nickname/number separator) break URL round-tripping.
+      #
+      # @raise [ConfigurationError] when any resolved nickname collides with another or contains non-token chars
+      #
+      # @return [void]
+      #
+      def validate_repo_nicknames!
+        resolved = repos.keys.index_with { |key| repo_nickname_for(key).to_s }
+
+        invalid = resolved.reject { |_key, nickname| nickname.match?(/\A[A-Za-z0-9_]+\z/) }
+        if invalid.present?
+          pairs = invalid.map { |key, nickname| "#{key.inspect} => #{nickname.inspect}" }
+          raise(
+            PlanMyStuff::ConfigurationError,
+            "Invalid repo nickname(s) (must match /\\A[A-Za-z0-9_]+\\z/): #{pairs.join(', ')}",
+          )
+        end
+
+        dupes = resolved.group_by { |_key, nickname| nickname }.select { |_n, entries| entries.size > 1 }
+        return if dupes.blank?
+
+        details = dupes.map do |nickname, entries|
+          keys = entries.map { |entry| entry.first.inspect }.join(', ')
+          "#{nickname.inspect} (#{keys})"
+        end
+        raise(
+          PlanMyStuff::ConfigurationError,
+          "Duplicate repo nickname(s): #{details.join('; ')}",
+        )
+      end
   end
 
   class ConfigurationError < StandardError

data/lib/plan_my_stuff/issue.rb

@@ -255,16 +255,20 @@ module PlanMyStuff
 
       # Finds a single GitHub issue by number and parses its PMS metadata.
       #
+      # Accepts a numeric id (Integer or all-digit String) plus an optional +repo:+ kwarg, or a nickname-id String
+      # (e.g. +"Rawr-1234"+) where the repo is encoded in the prefix and +repo:+ is ignored.
+      #
       # @raise [Octokit::NotFound] when the issue number resolves to a pull request
+      # @raise [ArgumentError] when a nickname-id String references an unknown repo nickname
       #
-      # @param number [Integer]
-      # @param repo [Symbol, String, nil] defaults to config.default_repo
+      # @param id_or_number [Integer, String]
+      # @param repo [Symbol, String, nil] defaults to config.default_repo; ignored when +id_or_number+ is a nickname id
       #
       # @return [PlanMyStuff::Issue]
       #
-      def find(number, repo: nil)
+      def find(id_or_number, repo: nil)
+        number, resolved_repo = resolve_find_args(id_or_number, repo)
         client = PlanMyStuff.client
-        resolved_repo = client.resolve_repo!(repo)
 
         github_issue =
           fetch_with_etag_cache(
@@ -393,8 +397,68 @@ module PlanMyStuff
         raise(PlanMyStuff::APIError.new(e.message, status: e.respond_to?(:response_status) ? e.response_status : nil))
       end
 
+      # @raise [ArgumentError] when +repo+ resolves to a Repo with no configured key (cannot reverse-resolve through
+      #   +Repo.from_nickname!+, so the resulting token would not round-trip through +Issue.find+ / +from_param+)
+      #
+      # @param number [Integer]
+      # @param repo [String] full repo path, e.g. +"BrandsInsurance/Element"+
+      #
+      # @return [String]
+      #
+      def to_param(number, repo)
+        return if number.blank?
+        return if repo.blank?
+
+        repo_obj = PlanMyStuff::Repo.resolve!(repo)
+        if repo_obj.key.nil?
+          raise(
+            ArgumentError,
+            "Repo #{repo_obj.full_name.inspect} is not configured in config.repos; " \
+              'cannot build reversible Issue#to_param token',
+          )
+        end
+
+        "#{repo_obj.nickname}-#{number}"
+      end
+
+      # Parses an +Issue#to_param+ string of the form +"Nickname-1234"+ back into +[Repo, Integer]+. The repo is
+      # looked up via +PlanMyStuff::Repo.from_nickname!+, which scans +config.repos+ for the key whose
+      # +config.repo_nickname_for+ matches.
+      #
+      # @raise [ArgumentError] when +param+ does not match the +"Prefix-1234"+ shape or the prefix is not a known
+      #   repo nickname
+      #
+      # @param param [String]
+      #
+      # @return [Array(PlanMyStuff::Repo, Integer)]
+      #
+      def from_param(param)
+        match = param.to_s.match(/\A(?<nickname>.+)-(?<number>\d+)\z/)
+        raise(ArgumentError, "Invalid issue param: #{param.inspect}") if match.nil?
+
+        [PlanMyStuff::Repo.from_nickname!(match[:nickname]), match[:number].to_i]
+      end
+
       private
 
+        # Splits the +Issue.find+ first arg into +[number, resolved_repo_full_name]+. A nickname-id String like
+        # +"Rawr-1234"+ is decoded via +from_param+ (repo derived from the prefix; +repo:+ kwarg ignored). All other
+        # inputs (Integer, all-digit String) fall through to the existing +client.resolve_repo!+ path with the kwarg.
+        #
+        # @param id_or_number [Integer, String]
+        # @param repo [Symbol, String, PlanMyStuff::Repo, nil]
+        #
+        # @return [Array(Integer, String)]
+        #
+        def resolve_find_args(id_or_number, repo)
+          if id_or_number.is_a?(String) && !id_or_number.match?(/\A\d+\z/)
+            repo_obj, number = from_param(id_or_number)
+            [number, repo_obj.full_name]
+          else
+            [id_or_number.to_i, PlanMyStuff.client.resolve_repo!(repo)]
+          end
+        end
+
         # Resolves an +issue_type:+ kwarg to the literal display name GitHub expects. Two stages: a Symbol is first
         # looked up in the gem-side +ISSUE_TYPE_NICKNAMES+ to get a canonical name; then the canonical (or
         # directly-provided String) name is passed through +config.issue_types+ for org-specific renames. Missing
@@ -443,9 +507,8 @@ module PlanMyStuff
         end
 
         # 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.
+        # per-issue URL (in +Issue#to_param+ form, e.g. +"/issues/Rawr-1234"+), 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"+
@@ -456,7 +519,8 @@ module PlanMyStuff
           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)}"
+          to_par = to_param(number, repo)
+          url = "#{prefix.to_s.chomp('/')}/#{to_par}"
           "[#{repo}##{number}](#{url})"
         end
 
@@ -526,17 +590,29 @@ 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.
+    # Single-segment URL token combining repo nickname and issue number, used by Rails route helpers
+    # (+youtrack_issue_path(@issue)+ -> +"/issues/Rawr-1234"+). Returns +nil+ for new records or when +number+ or
+    # +repo+ is unset; +Issue.from_param+ parses the same shape back into +[Repo, Integer]+.
+    #
+    # @return [String, nil]
+    #
+    def to_param
+      return if new_record?
+
+      self.class.to_param(number, repo)
+    end
+
+    # @return [String, nil] per-issue URL in the consuming app (+config.issues_url_prefix+ + +"/"+ + +to_param+, or
+    #   +nil+ when prefix, number, or repo 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?
+      return if prefix.blank?
 
-      base = "#{prefix.to_s.chomp('/')}/#{number}"
-      return base if repo.blank?
+      to_par = to_param
+      return if to_par.blank?
 
-      "#{base}?repo=#{URI.encode_www_form_component(repo.full_name)}"
+      "#{prefix.to_s.chomp('/')}/#{to_par}"
     end
 
     # Tags the issue with the configured +archived_label+, removes it from every Projects V2 board it belongs to,

data/lib/plan_my_stuff/repo.rb

@@ -55,6 +55,23 @@ module PlanMyStuff
         end
       end
 
+      # Reverse lookup for the +Issue#to_param+ prefix: finds the configured repo whose nickname (per
+      # +config.repo_nickname_for+) matches +nickname+ and returns its +Repo+ instance.
+      #
+      # @raise [ArgumentError] if no configured repo has the given nickname
+      #
+      # @param nickname [String]
+      #
+      # @return [PlanMyStuff::Repo]
+      #
+      def from_nickname!(nickname)
+        config = PlanMyStuff.configuration
+        match = config.repos.keys.find { |key| config.repo_nickname_for(key) == nickname }
+        raise(ArgumentError, "Unknown repo nickname: #{nickname.inspect}") if match.nil?
+
+        resolve!(match)
+      end
+
       private
 
         # @raise [ArgumentError] if full_name is not in "Org/Repo" format
@@ -88,6 +105,17 @@ module PlanMyStuff
       "#{organization}/#{name}"
     end
 
+    # Human-readable repo label used as the +Issue#to_param+ prefix. Resolves through +config.repo_nickname_for+
+    # when this repo carries a configured +key+; falls back to the bare repo +name+ for unconfigured repos.
+    #
+    # @return [String]
+    #
+    def nickname
+      return PlanMyStuff.configuration.repo_nickname_for(key) if key
+
+      name
+    end
+
     # @see #full_name
     alias to_s full_name
 

data/lib/plan_my_stuff/version.rb

@@ -3,7 +3,7 @@
 module PlanMyStuff
   module VERSION
     MAJOR = 0
-    MINOR = 17
+    MINOR = 18
     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.17.0
+  version: 0.18.0
 platform: ruby
 authors:
 - Brands Insurance