plan_my_stuff 0.17.0 → 0.19.0

data/app/controllers/plan_my_stuff/labels_controller.rb

@@ -7,40 +7,46 @@ 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)
 
+      yield(issue) if block_given?
+      return if performed?
+
       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]])
 
+      yield(issue) if block_given?
+      return if performed?
+
       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/controllers/plan_my_stuff/project_items/assignments_controller.rb

@@ -16,6 +16,9 @@ module PlanMyStuff
 
         item.assign!(assignees)
 
+        yield(item) if block_given?
+        return if performed?
+
         flash[:success] =
           if assignees.present?
             "Item assigned to #{assignees.join(', ')}."
@@ -43,6 +46,9 @@ module PlanMyStuff
 
         item.assign!(remaining)
 
+        yield(item) if block_given?
+        return if performed?
+
         flash[:success] = "#{params[:username]} unassigned."
         redirect_to(plan_my_stuff.project_path(params[:project_id]))
       rescue ArgumentError, PlanMyStuff::Error => e

data/app/controllers/plan_my_stuff/project_items/statuses_controller.rb

@@ -14,6 +14,9 @@ module PlanMyStuff
 
         item.move_to!(params[:status])
 
+        yield(item) if block_given?
+        return if performed?
+
         flash[:success] = "Item moved to #{params[:status]}."
         redirect_to(plan_my_stuff.project_path(params[:project_id]))
       rescue ArgumentError, PlanMyStuff::Error => e

data/app/controllers/plan_my_stuff/project_items_controller.rb

@@ -7,19 +7,23 @@ module PlanMyStuff
       project_number = params[:project_id].to_i
 
       if params[:draft] == '1'
-        PlanMyStuff::ProjectItem.create!(
+        item = PlanMyStuff::ProjectItem.create!(
           params[:title],
           draft: true,
           body: params[:body],
           project_number: project_number,
         )
-        flash[:success] = 'Draft item created.'
+        flash_message = 'Draft item created.'
       else
         issue = PlanMyStuff::Issue.find(params[:issue_number].to_i)
-        PlanMyStuff::ProjectItem.create!(issue, project_number: project_number)
-        flash[:success] = "Issue ##{issue.number} added to project."
+        item = PlanMyStuff::ProjectItem.create!(issue, project_number: project_number)
+        flash_message = "Issue ##{issue.number} added to project."
       end
 
+      yield(item) if block_given?
+      return if performed?
+
+      flash[:success] = flash_message
       redirect_to(plan_my_stuff.project_path(project_number))
     rescue ArgumentError, PlanMyStuff::Error, Octokit::Error => e
       pms_handle_rescue(e)
@@ -38,6 +42,9 @@ module PlanMyStuff
 
       item.destroy!(user: pms_current_user)
 
+      yield(item) if block_given?
+      return if performed?
+
       flash[:success] = 'Item removed from project.'
       redirect_to(plan_my_stuff.project_path(project_number))
     rescue ArgumentError, PlanMyStuff::Error, Octokit::Error => e

data/app/controllers/plan_my_stuff/projects_controller.rb

@@ -12,11 +12,15 @@ module PlanMyStuff
         when 'regular' then all_projects.reject { |p| p.is_a?(PlanMyStuff::TestingProject) }
         else all_projects
         end
+
+      yield(@projects) if block_given?
     end
 
     # GET /projects/new
     def new
       @project = PlanMyStuff::Project.new
+
+      yield(@project) if block_given?
     end
 
     # POST /projects
@@ -28,6 +32,9 @@ module PlanMyStuff
         user: pms_current_user,
       )
 
+      yield(@project) if block_given?
+      return if performed?
+
       flash[:success] = 'Project was successfully created.'
       redirect_to(plan_my_stuff.project_path(@project.number))
     rescue PlanMyStuff::ValidationError => e
@@ -46,11 +53,15 @@ module PlanMyStuff
       @project = PlanMyStuff::Project.find(params[:id].to_i)
       @statuses = @project.statuses.pluck(:name)
       @items_by_status = @project.items.group_by(&:status)
+
+      yield(@project) if block_given?
     end
 
     # GET /projects/:id/edit
     def edit
       @project = PlanMyStuff::Project.find(params[:id].to_i)
+
+      yield(@project) if block_given?
     end
 
     # PATCH/PUT /projects/:id
@@ -63,6 +74,9 @@ module PlanMyStuff
         description: project_params[:description],
       )
 
+      yield(@project) if block_given?
+      return if performed?
+
       flash[:success] = 'Project was successfully updated.'
       redirect_to(plan_my_stuff.project_path(@project.number))
     rescue PlanMyStuff::StaleObjectError => e

data/app/controllers/plan_my_stuff/testing_project_items/results_controller.rb

@@ -30,6 +30,9 @@ module PlanMyStuff
           raise(ArgumentError, "Invalid result: #{params[:result].inspect}")
         end
 
+        yield(item) if block_given?
+        return if performed?
+
         redirect_to(plan_my_stuff.testing_project_path(project_number))
       rescue PlanMyStuff::ValidationError => e
         pms_handle_rescue(e)

data/app/controllers/plan_my_stuff/testing_project_items_controller.rb

@@ -5,6 +5,8 @@ module PlanMyStuff
     # GET /testing_projects/:testing_project_id/items/new
     def new
       @project = PlanMyStuff::TestingProject.find(params[:testing_project_id].to_i)
+
+      yield(@project) if block_given?
     rescue PlanMyStuff::Error, Octokit::Error => e
       pms_handle_rescue(e)
       flash[:error] = e.message
@@ -26,6 +28,9 @@ module PlanMyStuff
       item.update_due_date!(Date.parse(item_params[:due_date])) if item_params[:due_date].present?
       item.update_pass_mode!(item_params[:pass_mode]) if item_params[:pass_mode].present?
 
+      yield(item) if block_given?
+      return if performed?
+
       flash[:success] = 'Item added.'
       redirect_to(plan_my_stuff.testing_project_path(project_number))
     rescue ArgumentError, PlanMyStuff::Error, Octokit::Error => e

data/app/controllers/plan_my_stuff/testing_projects_controller.rb

@@ -6,6 +6,8 @@ module PlanMyStuff
     def new
       @project = PlanMyStuff::TestingProject.new
       @project.metadata.subject_urls = [params[:subject_url]] if params[:subject_url].present?
+
+      yield(@project) if block_given?
     end
 
     # POST /testing_projects
@@ -19,6 +21,9 @@ module PlanMyStuff
         user: pms_current_user,
       )
 
+      yield(@project) if block_given?
+      return if performed?
+
       flash[:success] = 'Testing project was successfully created.'
       redirect_to(plan_my_stuff.testing_project_path(@project.number))
     rescue PlanMyStuff::ValidationError => e
@@ -39,11 +44,15 @@ module PlanMyStuff
       @project = PlanMyStuff::TestingProject.find(params[:id].to_i)
       @statuses = @project.statuses.pluck(:name)
       @items_by_status = @project.items.group_by(&:status)
+
+      yield(@project) if block_given?
     end
 
     # GET /testing_projects/:id/edit
     def edit
       @project = PlanMyStuff::TestingProject.find(params[:id].to_i)
+
+      yield(@project) if block_given?
     end
 
     # PATCH/PUT /testing_projects/:id
@@ -60,6 +69,9 @@ module PlanMyStuff
         },
       )
 
+      yield(@project) if block_given?
+      return if performed?
+
       flash[:success] = 'Testing project was successfully updated.'
       redirect_to(plan_my_stuff.testing_project_path(@project.number))
     rescue PlanMyStuff::StaleObjectError => e

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