plan_my_stuff 0.18.0 → 0.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bded03d75c7bd996c62c647b038a588a4286628e7f041e385d4464ea87955505
-  data.tar.gz: 5b778d271d85a1ad5681d8617dec41875d5664d0c3ea861ab9421bef962de4d2
+  metadata.gz: 15988155f3d1798b5b0f43cbb1597f7e8b7ed881feb3db2504da7ecd74ab9c59
+  data.tar.gz: 35f298dce675a86ca15153a354411c23806e8420374fe5eb4fd7d2c392e0ed9d
 SHA512:
-  metadata.gz: db446cfa7623c4091f67cecd89ab7dfe84207237e601fd53f4a73401fc02d2019072801c326d281febb54373817cb87d35c60e2929a2ec425f1aca3e7623ef49
-  data.tar.gz: b7f4328f697271829202ee201f4c05a9e1553bc95d50b721cfc3132462c0401428b87e22bd79cdeb4962e249bea991b3f5d39cab9cb1a3c048ef13a647e31312
+  metadata.gz: 838ebf5cb77a3467fb291d76acd9b2ded4cc40d88e65673ca41374324736c6cdc11e5bbc0ed7e04eaf0c0bb5ac4f799c3052379cdc87edcd7343dc30be370059
+  data.tar.gz: b30d829c2255b61485c72d639992f1095f9726b7e6d8952114eef2e44c91f1016c0f05bd3abd238faf0be83a37c8b75ef492208351d33cbbe1f2f689270e7614

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.19.0
+
+### Added
+
+- Every controller action now yields its primary object to a block when subclassed, so consumers can do
+  `super do |obj| ... end` to wedge in audit-log / instrumentation without rewriting the action. Webhook
+  controllers yield `(payload, result)`. See [CONFIGURATION.md](CONFIGURATION.md).
+
 ## 0.18.0
 
 ### Breaking

data/CONFIGURATION.md

@@ -374,6 +374,54 @@ Controllable keys (with gem defaults):
 | `:'webhooks/github'` | `plan_my_stuff/webhooks/github` |
 | `:'webhooks/aws'` | `plan_my_stuff/webhooks/aws` |
 
+### Customizing per-action behavior
+
+Every mounted route resolves its controller through `config.controller_for(key)`. Subclass a gem controller in your
+own app and register it to wedge in `before_action`s, authentication, or response tweaks - no monkey patching:
+
+```ruby
+# app/controllers/my_app/issues_controller.rb
+class MyApp::IssuesController < PMS::IssuesController
+  before_action :authenticate_user!
+  before_action :authorize_ticket_access
+end
+```
+
+```ruby
+# config/initializers/plan_my_stuff.rb
+PlanMyStuff.configure do |config|
+  config.controllers[:issues] = 'my_app/issues'
+end
+```
+
+For per-action side effects (audit log, metrics, notifications) without rewriting the action, yielding actions
+pass their primary object to an optional block on the happy path. Call `super do |obj| ... end` from a subclass:
+
+```ruby
+class MyApp::IssuesController < PMS::IssuesController
+  def create
+    super do |issue|
+      AuditLog.record(actor: current_user, action: :issue_created, target: issue)
+    end
+  end
+
+  def update
+    super do |issue|
+      AuditLog.record(actor: current_user, action: :issue_updated, target: issue)
+    end
+  end
+end
+```
+
+Contract:
+
+- The yield fires on the happy path, after the model load / write succeeds and before the gem's default
+  `flash[:success]` + `redirect_to`. Error branches, `not_found`, and authorization redirects do not yield.
+- Read actions (`index`, `show`, `new`, `edit`) yield before the implicit render; `index` yields the collection,
+  the rest yield the single object.
+- If your block calls `render` or `redirect_to`, the gem's default response is skipped (the action checks
+  `performed?`), so you can fully replace the response from the block.
+
 ### Parent controller
 
 | Option | Type | Default | Description |

data/README.md

@@ -787,34 +787,6 @@ All routes are under the engine's mount point. Each group can be disabled via `c
 
 ## Controller overrides
 
-Every mounted route resolves its controller through `config.controller_for(key)`, which looks up `config.controllers[key]` and falls back to the gem default. Subclass a gem controller in your own app and register it to wedge in before_actions, authentication, or response tweaks — no monkey patching.
-
-```ruby
-# app/controllers/my_app/issues_controller.rb
-class MyApp::IssuesController < PMS::IssuesController
-  before_action :authenticate_user!
-  before_action :authorize_ticket_access
-end
-```
-
-```ruby
-# config/initializers/plan_my_stuff.rb
-PlanMyStuff.configure do |config|
-  config.controllers['issues'] = 'my_app/issues'
-end
-```
-
-Overridable keys (see `PMS::Configuration::DEFAULT_CONTROLLERS`):
-
-```text
-issues                         issues/closures
-comments                       issues/viewers
-labels                         issues/takes
-projects                       issues/waitings
-project_items                  issues/links
-testing_projects               issues/approvals
-testing_project_items          project_items/statuses
-webhooks/github                project_items/assignments
-webhooks/aws                   testing_project_items/results
-```
+See [CONFIGURATION.md](CONFIGURATION.md#controller-overrides) for the full walkthrough including subclassing,
+per-route registration, and the per-action block hook.
 

data/app/controllers/plan_my_stuff/comments_controller.rb

@@ -6,7 +6,7 @@ module PlanMyStuff
     def create
       @issue = PlanMyStuff::Issue.find(params[:issue_id])
 
-      PlanMyStuff::Comment.create!(
+      comment = PlanMyStuff::Comment.create!(
         issue: @issue,
         body: comment_params[:body],
         user: pms_current_user,
@@ -14,6 +14,9 @@ module PlanMyStuff
         waiting_on_reply: comment_params[:waiting_on_reply] == '1',
       )
 
+      yield(comment) if block_given?
+      return if performed?
+
       flash[:success] = 'Comment was successfully created.'
       redirect_to(plan_my_stuff.issue_path(@issue))
     rescue PlanMyStuff::LockedIssueError => e
@@ -27,9 +30,14 @@ module PlanMyStuff
       load_comment
       return unless @comment
       return redirect_to_issue if issue_body_comment?
-      return if can_edit?(@comment)
 
-      redirect_to_unauthorized(plan_my_stuff.issue_path(@issue))
+      unless can_edit?(@comment)
+        redirect_to_unauthorized(plan_my_stuff.issue_path(@issue))
+
+        return
+      end
+
+      yield(@comment) if block_given?
     end
 
     # PATCH/PUT /issues/:issue_id/comments/:id
@@ -49,6 +57,9 @@ module PlanMyStuff
 
       @comment.update!(**update_attrs, user: pms_current_user)
 
+      yield(@comment) if block_given?
+      return if performed?
+
       flash[:success] = 'Comment was successfully updated.'
       redirect_to(plan_my_stuff.issue_path(@issue))
     rescue PlanMyStuff::StaleObjectError => e

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

@@ -26,6 +26,9 @@ module PlanMyStuff
         issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.request_approvals!(user_ids: user_ids, user: pms_current_user)
 
+        yield(issue) if block_given?
+        return if performed?
+
         flash[:success] = 'Approvers were successfully added.'
         redirect_to(show_path)
       rescue PlanMyStuff::AuthorizationError, PlanMyStuff::ValidationError => e
@@ -71,6 +74,9 @@ module PlanMyStuff
           flash[:success] = 'Response revoked.'
         end
 
+        yield(issue) if block_given?
+        return if performed?
+
         redirect_to(show_path)
       rescue PlanMyStuff::AuthorizationError, PlanMyStuff::ValidationError => e
         pms_handle_rescue(e)
@@ -88,6 +94,9 @@ module PlanMyStuff
         issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.remove_approvers!(user_ids: [params[:id].to_i], user: pms_current_user)
 
+        yield(issue) if block_given?
+        return if performed?
+
         flash[:success] = 'Approver was successfully removed.'
         redirect_to(show_path)
       rescue PlanMyStuff::AuthorizationError, PlanMyStuff::ValidationError => e

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

@@ -14,6 +14,9 @@ module PlanMyStuff
         issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.update!(state: :closed)
 
+        yield(issue) if block_given?
+        return if performed?
+
         flash[:success] = 'Issue was successfully closed.'
         redirect_to(plan_my_stuff.issue_path(issue))
       rescue PlanMyStuff::Error, ArgumentError => e
@@ -27,6 +30,9 @@ module PlanMyStuff
         issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.update!(state: :open)
 
+        yield(issue) if block_given?
+        return if performed?
+
         flash[:success] = 'Issue was successfully reopened.'
         redirect_to(plan_my_stuff.issue_path(issue))
       rescue PlanMyStuff::Error, ArgumentError => e

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

@@ -28,6 +28,9 @@ module PlanMyStuff
         issue = PlanMyStuff::Issue.find(params[:issue_id])
         link = add_link(issue, type)
 
+        yield(issue) if block_given?
+        return if performed?
+
         flash[:success] = "Linked #{link}"
         redirect_to(plan_my_stuff.issue_path(issue))
       rescue PlanMyStuff::ValidationError, ActiveModel::ValidationError, ArgumentError => e
@@ -47,6 +50,9 @@ module PlanMyStuff
         issue = PlanMyStuff::Issue.find(params[:issue_id])
         remove_link(issue, type, repo: repo, number: number)
 
+        yield(issue) if block_given?
+        return if performed?
+
         flash[:success] = "Unlinked #{repo}##{number}"
         redirect_to(plan_my_stuff.issue_path(issue))
       rescue PlanMyStuff::ValidationError, ActiveModel::ValidationError, ArgumentError => e

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

@@ -19,6 +19,10 @@ module PlanMyStuff
 
         PlanMyStuff::Pipeline.take!(project_item)
         assign_current_user(project_item)
+
+        yield(project_item) if block_given?
+        return if performed?
+
         flash[:success] ||= "Issue ##{issue.number} taken."
 
         redirect_to(plan_my_stuff.issue_path(issue))
@@ -48,6 +52,10 @@ module PlanMyStuff
           issue.update!(assignees: remaining)
         end
 
+        yielded = project_item.presence || issue
+        yield(yielded) if block_given?
+        return if performed?
+
         flash[:success] = "Issue ##{issue.number} released."
         redirect_to(plan_my_stuff.issue_path(issue))
       rescue ArgumentError, PlanMyStuff::Error => e

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

@@ -26,6 +26,9 @@ module PlanMyStuff
         issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.add_viewers!(user_ids: viewer_ids, user: pms_current_user)
 
+        yield(issue) if block_given?
+        return if performed?
+
         flash[:success] = 'Viewers were successfully added.'
         redirect_to(plan_my_stuff.edit_issue_path(params[:issue_id]))
       rescue PlanMyStuff::Error, Octokit::Error => e
@@ -44,6 +47,9 @@ module PlanMyStuff
         issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.remove_viewers!(user_ids: [params[:id].to_i], user: pms_current_user)
 
+        yield(issue) if block_given?
+        return if performed?
+
         flash[:success] = 'Viewer was successfully removed.'
         redirect_to(plan_my_stuff.edit_issue_path(params[:issue_id]))
       rescue PlanMyStuff::Error, Octokit::Error => e

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

@@ -19,6 +19,9 @@ module PlanMyStuff
         issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.enter_waiting_on_user!(user: pms_current_user)
 
+        yield(issue) if block_given?
+        return if performed?
+
         flash[:success] = 'Issue marked as waiting on user reply.'
         redirect_to(plan_my_stuff.issue_path(issue))
       rescue PlanMyStuff::Error, ArgumentError => e
@@ -37,6 +40,9 @@ module PlanMyStuff
         issue = PlanMyStuff::Issue.find(params[:issue_id])
         issue.clear_waiting_on_user!
 
+        yield(issue) if block_given?
+        return if performed?
+
         flash[:success] = 'Waiting-on-user state cleared.'
         redirect_to(plan_my_stuff.issue_path(issue))
       rescue PlanMyStuff::Error, ArgumentError => e

data/app/controllers/plan_my_stuff/issues_controller.rb

@@ -17,11 +17,15 @@ module PlanMyStuff
         page: @page,
         per_page: @per_page,
       )
+
+      yield(@issues) if block_given?
     end
 
     # GET /issues/new
     def new
       @issue = PlanMyStuff::Issue.new
+
+      yield(@issue) if block_given?
     end
 
     # POST /issues
@@ -33,6 +37,9 @@ module PlanMyStuff
         user: pms_current_user,
       )
 
+      yield(@issue) if block_given?
+      return if performed?
+
       flash[:success] = 'Issue was successfully created.'
       redirect_to(plan_my_stuff.issue_path(@issue))
     rescue PlanMyStuff::ValidationError => e
@@ -50,11 +57,15 @@ module PlanMyStuff
       @current_user_login = PlanMyStuff.configuration.github_login_for[@current_user_id]
       @pipeline_enabled = PlanMyStuff.configuration.pipeline_enabled
       @pipeline_item = load_pipeline_item(@issue.number) if @pipeline_enabled
+
+      yield(@issue) if block_given?
     end
 
     # GET /issues/:id/edit
     def edit
       @issue = PlanMyStuff::Issue.find(params[:id])
+
+      yield(@issue) if block_given?
     end
 
     # PATCH/PUT /issues/:id
@@ -67,6 +78,9 @@ module PlanMyStuff
         labels: parse_labels(issue_params[:labels]),
       )
 
+      yield(@issue) if block_given?
+      return if performed?
+
       flash[:success] = 'Issue was successfully updated.'
       redirect_to(plan_my_stuff.issue_path(@issue))
     rescue PlanMyStuff::StaleObjectError => e

data/app/controllers/plan_my_stuff/labels_controller.rb

@@ -22,6 +22,9 @@ module PlanMyStuff
 
       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))
     rescue PlanMyStuff::Error, Octokit::Error => e
@@ -35,6 +38,9 @@ module PlanMyStuff
       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))
     rescue PlanMyStuff::Error, Octokit::Error => e

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/lib/plan_my_stuff/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: plan_my_stuff
 version: !ruby/object:Gem::Version
-  version: 0.18.0
+  version: 0.19.0
 platform: ruby
 authors:
 - Brands Insurance
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2026-05-19 00:00:00.000000000 Z
+date: 2026-05-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails