plan_my_stuff 0.14.0 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4bb39718bce95afcf03151d7feaed80b192a9d0ae9224ca1cbe1da5936b38cc7
-  data.tar.gz: 3d82fabbea5dc402278882bd93eedc21d7cbfaf8e868c13f30dfc759a6dc964e
+  metadata.gz: 8a3c6c6445f04d677b6d6b4f0219f57326346b3f42aee6839ab98a0bbf680e63
+  data.tar.gz: f5f5adb4f7a11e2d35b907ae7ab1e15d9dc47f31313355be7da186bf9c5086d6
 SHA512:
-  metadata.gz: d6195d4cd41797ac803b4c3b0fb8a009782f616a2e634f20eb94415f6863337e6ec46705fc0b75af1cd8ff37f07254b7dc3b14e46aff0d3a087bcb01c2adcab3
-  data.tar.gz: fcc8ed29694e8256132207014bf6f9ceea3fc0f93c9a50cc11601d22cbc745c09e16f058ba243b6069a9662669f3675e6877eaffd97316487ed810ef5a73e1df
+  metadata.gz: a31f3331be41dcd8c4a1369f729888e06ec64474a58c0b56d2c7d57d69b647b1f33b7acc0ae4eed26f03491ce5736a3ab60656900fc31e731bbadd2ae68c492c
+  data.tar.gz: 429281e1a5b431ab29fc5c2d91f15176c7556533df7a94d9990dc3e98a198d5b2d603205bd29f5d4efd210c131bc67b7d440de296857f2eeddd5c085fbc799a2

data/CHANGELOG.md

@@ -1,5 +1,46 @@
 # Changelog
 
+## 0.15.0
+
+### Breaking
+
+- `ActiveSupport::Notifications` events renamed to follow Rails' convention (event first, library
+  last). Subscribers matching the old `plan_my_stuff.*` prefix must switch to `*.plan_my_stuff`.
+
+  | Old                                          | New                                          |
+  |----------------------------------------------|----------------------------------------------|
+  | `plan_my_stuff.issue.created`                | `issue_created.plan_my_stuff`                |
+  | `plan_my_stuff.issue.updated`                | `issue_updated.plan_my_stuff`                |
+  | `plan_my_stuff.issue.closed`                 | `issue_closed.plan_my_stuff`                 |
+  | `plan_my_stuff.issue.reopened`               | `issue_reopened.plan_my_stuff`               |
+  | `plan_my_stuff.issue.archived`               | `issue_archived.plan_my_stuff`               |
+  | `plan_my_stuff.issue.closed_inactive`        | `issue_closed_inactive.plan_my_stuff`        |
+  | `plan_my_stuff.issue.reopened_by_reply`      | `issue_reopened_by_reply.plan_my_stuff`      |
+  | `plan_my_stuff.issue.marked_duplicate`       | `issue_marked_duplicate.plan_my_stuff`       |
+  | `plan_my_stuff.issue.viewers_added`          | `issue_viewers_added.plan_my_stuff`          |
+  | `plan_my_stuff.issue.viewers_removed`        | `issue_viewers_removed.plan_my_stuff`        |
+  | `plan_my_stuff.issue.approval_requested`     | `issue_approval_requested.plan_my_stuff`     |
+  | `plan_my_stuff.issue.approval_granted`       | `issue_approval_granted.plan_my_stuff`       |
+  | `plan_my_stuff.issue.approval_revoked`       | `issue_approval_revoked.plan_my_stuff`       |
+  | `plan_my_stuff.issue.approval_rejected`      | `issue_approval_rejected.plan_my_stuff`      |
+  | `plan_my_stuff.issue.rejection_revoked`      | `issue_rejection_revoked.plan_my_stuff`      |
+  | `plan_my_stuff.issue.all_approved`           | `issue_all_approved.plan_my_stuff`           |
+  | `plan_my_stuff.issue.approvals_invalidated`  | `issue_approvals_invalidated.plan_my_stuff`  |
+  | `plan_my_stuff.issue.reminder_due`           | `issue_reminder_due.plan_my_stuff`           |
+  | `plan_my_stuff.issue.link_reciprocal_failed` | `issue_link_reciprocal_failed.plan_my_stuff` |
+  | `plan_my_stuff.comment.created`              | `comment_created.plan_my_stuff`              |
+  | `plan_my_stuff.comment.updated`              | `comment_updated.plan_my_stuff`              |
+  | `plan_my_stuff.label.added`                  | `label_added.plan_my_stuff`                  |
+  | `plan_my_stuff.label.removed`                | `label_removed.plan_my_stuff`                |
+  | `plan_my_stuff.project_item.added`           | `project_item_added.plan_my_stuff`           |
+  | `plan_my_stuff.project_item.removed`         | `project_item_removed.plan_my_stuff`         |
+  | `plan_my_stuff.project_item.assigned`        | `project_item_assigned.plan_my_stuff`        |
+  | `plan_my_stuff.project_item.status_changed`  | `project_item_status_changed.plan_my_stuff`  |
+  | `plan_my_stuff.pipeline.<status>`            | `pipeline_<status>.plan_my_stuff`            |
+
+  Rationale: aligns with `sql.active_record`, `process_action.action_controller`, etc. and lets
+  subscribers match "everything from PMS" via the standard suffix-regex (`/\.plan_my_stuff$/`).
+
 ## 0.14.0
 
 ### Added

data/README.md

@@ -267,31 +267,34 @@ A board and its items are editable through the mounted UI at `/testing_projects`
 
 ## Notifications
 
-Every PMS lifecycle write fires an `ActiveSupport::Notifications` event under the `plan_my_stuff.*` namespace. Subscribe to drive email, webhooks, Slack, ActiveJob, etc. Events fire synchronously (no delays) — subscribers that need to defer work should wrap in a background job themselves.
+Every PMS lifecycle write fires an `ActiveSupport::Notifications` event under the `*.plan_my_stuff` namespace
+(Rails convention - event first, library suffix; matches `sql.active_record`, `process_action.action_controller`).
+Subscribe to drive email, webhooks, Slack, ActiveJob, etc. Events fire synchronously (no delays) - subscribers
+that need to defer work should wrap in a background job themselves.
 
 ### Event catalog
 
 | Event | Fired from |
 |-------|------------|
-| `plan_my_stuff.issue.created` | `Issue.create!` |
-| `plan_my_stuff.issue.updated` | `issue.save!` / `issue.update!` (any non-state change) |
-| `plan_my_stuff.issue.closed` | `issue.update!(state: :closed)` |
-| `plan_my_stuff.issue.reopened` | `issue.update!(state: :open)` |
-| `plan_my_stuff.issue.viewers_added` | `issue.add_viewers!` |
-| `plan_my_stuff.issue.viewers_removed` | `issue.remove_viewers!` |
-| `plan_my_stuff.issue.approval_requested` | `issue.request_approvals!` |
-| `plan_my_stuff.issue.approval_granted` | `issue.approve!` |
-| `plan_my_stuff.issue.approval_revoked` | `issue.revoke_approval!` |
-| `plan_my_stuff.issue.all_approved` | aggregate — fires when the set flips to fully approved |
-| `plan_my_stuff.issue.approvals_invalidated` | aggregate — fires when a revoke (or new approver) drops the set out of fully-approved |
-| `plan_my_stuff.comment.created` | `Comment.create!` |
-| `plan_my_stuff.comment.updated` | `comment.save!` / `comment.update!` |
-| `plan_my_stuff.label.added` | `Label.add!` |
-| `plan_my_stuff.label.removed` | `Label.remove!` |
-| `plan_my_stuff.project_item.added` | `ProjectItem.create!` (issue or `draft: true`) |
-| `plan_my_stuff.project_item.removed` | `project_item.destroy!` |
-| `plan_my_stuff.project_item.assigned` | `project_item.assign!` |
-| `plan_my_stuff.project_item.status_changed` | `project_item.move_to!` |
+| `issue_created.plan_my_stuff` | `Issue.create!` |
+| `issue_updated.plan_my_stuff` | `issue.save!` / `issue.update!` (any non-state change) |
+| `issue_closed.plan_my_stuff` | `issue.update!(state: :closed)` |
+| `issue_reopened.plan_my_stuff` | `issue.update!(state: :open)` |
+| `issue_viewers_added.plan_my_stuff` | `issue.add_viewers!` |
+| `issue_viewers_removed.plan_my_stuff` | `issue.remove_viewers!` |
+| `issue_approval_requested.plan_my_stuff` | `issue.request_approvals!` |
+| `issue_approval_granted.plan_my_stuff` | `issue.approve!` |
+| `issue_approval_revoked.plan_my_stuff` | `issue.revoke_approval!` |
+| `issue_all_approved.plan_my_stuff` | aggregate; fires when the set flips to fully approved |
+| `issue_approvals_invalidated.plan_my_stuff` | aggregate; fires on revoke or new approver dropping the set |
+| `comment_created.plan_my_stuff` | `Comment.create!` |
+| `comment_updated.plan_my_stuff` | `comment.save!` / `comment.update!` |
+| `label_added.plan_my_stuff` | `Label.add!` |
+| `label_removed.plan_my_stuff` | `Label.remove!` |
+| `project_item_added.plan_my_stuff` | `ProjectItem.create!` (issue or `draft: true`) |
+| `project_item_removed.plan_my_stuff` | `project_item.destroy!` |
+| `project_item_assigned.plan_my_stuff` | `project_item.assign!` |
+| `project_item_status_changed.plan_my_stuff` | `project_item.move_to!` |
 
 ### Payload
 
@@ -304,14 +307,14 @@ All events include:
 
 Additional keys by event:
 
-- `issue.updated` / `comment.updated` -> `:changes` — hash of `{ attr => [old, new] }`
-- `issue.viewers_added` / `viewers_removed` -> `:user_ids`
-- `issue.approval_requested` -> `:approvals` (array of newly-added `PMS::Approval`)
-- `issue.approval_granted` / `approval_revoked` -> `:approval` (the flipped `PMS::Approval`)
-- `issue.approvals_invalidated` -> `:trigger` — `:revoked` or `:approver_added`
-- `label.added` / `label.removed` -> `:labels`
-- `project_item.assigned` -> `:assignees`
-- `project_item.status_changed` -> `:status`, `:previous_status`
+- `issue_updated` / `comment_updated` -> `:changes` -- hash of `{ attr => [old, new] }`
+- `issue_viewers_added` / `issue_viewers_removed` -> `:user_ids`
+- `issue_approval_requested` -> `:approvals` (array of newly-added `PMS::Approval`)
+- `issue_approval_granted` / `issue_approval_revoked` -> `:approval` (the flipped `PMS::Approval`)
+- `issue_approvals_invalidated` -> `:trigger` -- `:revoked` or `:approver_added`
+- `label_added` / `label_removed` -> `:labels`
+- `project_item_assigned` -> `:assignees`
+- `project_item_status_changed` -> `:status`, `:previous_status`
 
 ### Actor resolution
 
@@ -327,7 +330,7 @@ Use `config.current_user = -> { Current.user }` so request-scoped code doesn't h
 
 ```ruby
 # config/initializers/plan_my_stuff_subscribers.rb
-ActiveSupport::Notifications.subscribe(/^plan_my_stuff\./) do |name, _start, _finish, _id, payload|
+ActiveSupport::Notifications.subscribe(/\.plan_my_stuff\z/) do |name, _start, _finish, _id, payload|
   PmsEventMailer.dispatch(name, payload).deliver_later
 end
 ```
@@ -340,13 +343,13 @@ require 'plan_my_stuff/test_helpers'
 # Block-style matcher
 expect {
   PMS::Issue.create!(title: 'Bug', body: 'Desc', user: alice)
-}.to(have_fired_event('plan_my_stuff.issue.created').with(user: alice))
+}.to(have_fired_event('issue_created.plan_my_stuff').with(user: alice))
 
 # Raw capture
 events = PMS::TestHelpers::Notifications.capture do
   PMS::Issue.create!(...)
 end
-events.first[:name]    # => "plan_my_stuff.issue.created"
+events.first[:name]    # => "issue_created.plan_my_stuff"
 events.first[:payload] # => { issue:, user:, timestamp:, ... }
 ```
 
@@ -412,7 +415,9 @@ issue.pending_approvals    # [PMS::Approval(user_id: bob.id, status: 'pending')]
 
 ## Reminders
 
-Follow-up reminders for issues waiting on an end-user reply or pending approvers. A daily sweep fires `plan_my_stuff.issue.reminder_due` events on waiting issues whose next milestone has passed; issues that exceed the inactivity ceiling are auto-closed.
+Follow-up reminders for issues waiting on an end-user reply or pending approvers. A daily sweep fires
+`issue_reminder_due.plan_my_stuff` events on waiting issues whose next milestone has passed; issues that exceed the
+inactivity ceiling are auto-closed.
 
 ### Waiting on user
 
@@ -433,7 +438,8 @@ A support user enters an issue into "waiting on user" state by either:
 
 Both paths add the `waiting-on-user` label, set `issue.metadata.waiting_on_user_at = now`, and schedule the first reminder.
 
-When an end-user posts a comment through the gem, the label is removed and the waiting state clears. If the issue had been auto-closed for inactivity, the reply also reopens it and fires `plan_my_stuff.issue.reopened_by_reply`.
+When an end-user posts a comment through the gem, the label is removed and the waiting state clears. If the issue had
+been auto-closed for inactivity, the reply also reopens it and fires `issue_reopened_by_reply.plan_my_stuff`.
 
 ### Waiting on approval
 
@@ -454,7 +460,7 @@ issue.metadata.reminder_days = [2, 5, 9]
 issue.save!
 ```
 
-Each reminder emits `plan_my_stuff.issue.reminder_due` with payload:
+Each reminder emits `issue_reminder_due.plan_my_stuff` with payload:
 
 | Field | Type | Notes |
 |---|---|---|
@@ -468,7 +474,7 @@ Each reminder emits `plan_my_stuff.issue.reminder_due` with payload:
 Subscribe in your app to deliver (email, Slack, etc.):
 
 ```ruby
-ActiveSupport::Notifications.subscribe('plan_my_stuff.issue.reminder_due') do |event|
+ActiveSupport::Notifications.subscribe('issue_reminder_due.plan_my_stuff') do |event|
   issue = event.payload[:issue]
   case event.payload[:waiting_kind]
   when :user     then NotifyUserMailer.reminder(issue).deliver_later
@@ -484,9 +490,11 @@ When an issue's `days_waiting` reaches `config.inactivity_close_days` (default 3
 - Closes the issue
 - Sets `issue.metadata.closed_by_inactivity = true`
 - Adds the `user-inactive` label (configurable via `config.user_inactive_label`)
-- Emits `plan_my_stuff.issue.closed_inactive` (with `reason: :inactivity`) — the regular `issue.closed` event is suppressed so subscribers listening to "close" don't double-fire for automated closes
+- Emits `issue_closed_inactive.plan_my_stuff` (with `reason: :inactivity`); the regular `issue_closed` event is
+  suppressed so subscribers listening to "close" don't double-fire for automated closes
 
-An end-user reply on a `closed_by_inactivity` issue auto-reopens it, strips the `user-inactive` label, and fires `plan_my_stuff.issue.reopened_by_reply`.
+An end-user reply on a `closed_by_inactivity` issue auto-reopens it, strips the `user-inactive` label, and fires
+`issue_reopened_by_reply.plan_my_stuff`.
 
 ### Scheduling the sweep
 
@@ -534,7 +542,7 @@ Closed PMS issues that have aged past `config.archive_closed_after_days` (defaul
 2. Lock the conversation on GitHub (no new comments).
 3. Remove the issue from every Projects V2 board it sits on.
 4. Stamp `metadata.archived_at`.
-5. Emit `plan_my_stuff.issue.archived` with `reason: :aged_closed`.
+5. Emit `issue_archived.plan_my_stuff` with `reason: :aged_closed`.
 
 The sweep runs inside `PMS::RemindersSweepJob` alongside the follow-up reminders sweep — same cadence, same rake task.
 
@@ -566,7 +574,7 @@ Locked issues reject new comments through the gem: `PMS::Comment.create!` raises
 ### Subscribing
 
 ```ruby
-ActiveSupport::Notifications.subscribe('plan_my_stuff.issue.archived') do |event|
+ActiveSupport::Notifications.subscribe('issue_archived.plan_my_stuff') do |event|
   issue = event.payload[:issue]
   ArchiveMailer.notify(issue).deliver_later
 end

data/app/controllers/plan_my_stuff/webhooks/github_controller.rb

@@ -161,7 +161,7 @@ module PlanMyStuff
         end
 
         # Handles GitHub's +projects_v2_item+ webhook event. Mirrors a dev dragging an item from "Submitted" to
-        # "Started" on the project board into a +Pipeline.take!+ call so the +plan_my_stuff.pipeline.started+
+        # "Started" on the project board into a +Pipeline.take!+ call so the +pipeline_started.plan_my_stuff+
         # event fires.
         #
         # Only acts on +action: 'edited'+ where the Status single-select field changed on the pipeline project.

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

@@ -108,7 +108,7 @@ PlanMyStuff.configure do |config|
   # --------------------------------------------------------------------------
   # Notification actor
   # --------------------------------------------------------------------------
-  # Fallback actor for notification events (plan_my_stuff.*) when a caller
+  # Fallback actor for notification events (*.plan_my_stuff) when a caller
   # does not pass an explicit user: kwarg. Proc/lambda called at event time.
   # config.current_user = -> { Current.user }
 
@@ -215,7 +215,7 @@ PlanMyStuff.configure do |config|
   # --------------------------------------------------------------------------
   # Follow-up reminders
   # --------------------------------------------------------------------------
-  # Daily sweep that fires `plan_my_stuff.issue.reminder_due` events on
+  # Daily sweep that fires `issue_reminder_due.plan_my_stuff` events on
   # waiting issues and auto-closes issues that exceed the inactivity
   # ceiling. Consuming app is responsible for the initial enqueue:
   #
@@ -251,7 +251,7 @@ PlanMyStuff.configure do |config|
   # `archive_closed_after_days` ago (based on GitHub's `closed_at`) the
   # sweep: adds the configured label, locks the conversation, removes
   # the issue from every Projects V2 board, stamps `metadata.archived_at`,
-  # and emits `plan_my_stuff.issue.archived` with `reason: :aged_closed`.
+  # and emits `issue_archived.plan_my_stuff` with `reason: :aged_closed`.
   # Issues auto-closed by the inactivity sweep (closed_by_inactivity) are
   # excluded. Non-PMS issues are excluded.
   #

data/lib/plan_my_stuff/base_project_item.rb

@@ -109,7 +109,7 @@ module PlanMyStuff
             add_item!(issue: issue_or_title, project_number: project_number)
           end
 
-        PlanMyStuff::Notifications.instrument('project_item.added', item, user: user)
+        PlanMyStuff::Notifications.instrument('project_item_added', item, user: user)
         item
       end
 
@@ -463,7 +463,7 @@ module PlanMyStuff
       )
 
       PlanMyStuff::Notifications.instrument(
-        'project_item.status_changed',
+        'project_item_status_changed',
         self,
         user: user,
         status: status,
@@ -520,7 +520,7 @@ module PlanMyStuff
         item_id: id,
       )
 
-      PlanMyStuff::Notifications.instrument('project_item.removed', self, user: user)
+      PlanMyStuff::Notifications.instrument('project_item_removed', self, user: user)
       destroyed!
       deleted_id
     end
@@ -544,7 +544,7 @@ module PlanMyStuff
       )
 
       PlanMyStuff::Notifications.instrument(
-        'project_item.assigned',
+        'project_item_assigned',
         self,
         user: user,
         assignees: assignee_list,

data/lib/plan_my_stuff/comment.rb

@@ -94,7 +94,7 @@ module PlanMyStuff
         mark_issue_responded_if_first_support_comment!(issue, resolved_user) unless skip_responded
 
         comment = build(result, issue: issue)
-        PlanMyStuff::Notifications.instrument('comment.created', comment, user: resolved_user)
+        PlanMyStuff::Notifications.instrument('comment_created', comment, user: resolved_user)
         apply_waiting_state_transitions!(issue, resolved_user, waiting_on_reply, comment)
         comment
       end
@@ -324,7 +324,7 @@ module PlanMyStuff
       self.class.update!(id: id, repo: issue.repo, body: serialized)
 
       reload
-      PlanMyStuff::Notifications.instrument('comment.updated', self, user: user, changes: captured_changes)
+      PlanMyStuff::Notifications.instrument('comment_updated', self, user: user, changes: captured_changes)
       self
     end
 

data/lib/plan_my_stuff/issue.rb

@@ -166,7 +166,7 @@ module PlanMyStuff
         issue.set_issue_fields!(issue_fields) if issue_fields.present?
 
         issue.reload
-        PlanMyStuff::Notifications.instrument('issue.created', issue, user: user)
+        PlanMyStuff::Notifications.instrument('issue_created', issue, user: user)
         issue
       end
 
@@ -509,7 +509,7 @@ module PlanMyStuff
     end
 
     # Tags the issue with the configured +archived_label+, removes it from every Projects V2 board it belongs to,
-    # locks its conversation on GitHub, and stamps +metadata.archived_at+. Emits +plan_my_stuff.issue.archived+ on
+    # locks its conversation on GitHub, and stamps +metadata.archived_at+. Emits +issue_archived.plan_my_stuff+ on
     # success.
     #
     # No-op (no network calls, no event) when the issue is already archived (either +metadata.archived_at+ is set or
@@ -542,7 +542,7 @@ module PlanMyStuff
       reload
 
       PlanMyStuff::Notifications.instrument(
-        'issue.archived',
+        'issue_archived',
         self,
         reason: :aged_closed,
       )
@@ -786,11 +786,11 @@ module PlanMyStuff
       def instrument_update(captured, user)
         case captured['state']
         when %w[open closed]
-          PlanMyStuff::Notifications.instrument('issue.closed', self, user: user)
+          PlanMyStuff::Notifications.instrument('issue_closed', self, user: user)
         when %w[closed open]
-          PlanMyStuff::Notifications.instrument('issue.reopened', self, user: user)
+          PlanMyStuff::Notifications.instrument('issue_reopened', self, user: user)
         else
-          PlanMyStuff::Notifications.instrument('issue.updated', self, user: user, changes: captured)
+          PlanMyStuff::Notifications.instrument('issue_updated', self, user: user, changes: captured)
         end
       end
 

data/lib/plan_my_stuff/issue_extractions/approvals.rb

@@ -33,8 +33,8 @@ module PlanMyStuff
       # Adds approvers to this issue's required-approvals list. Idempotent: users already present are no-ops. Only
       # support users may call this.
       #
-      # Fires +plan_my_stuff.issue.approval_requested+ when any user is newly added. Also fires
-      # +plan_my_stuff.issue.approvals_invalidated+ (+trigger: :approver_added+) when the new approvers flip the issue
+      # Fires +issue_approval_requested.plan_my_stuff+ when any user is newly added. Also fires
+      # +issue_approvals_invalidated.plan_my_stuff+ (+trigger: :approver_added+) when the new approvers flip the issue
       # out of a fully-approved state.
       #
       # @param user_ids [Array<Integer>, Integer]
@@ -81,8 +81,8 @@ module PlanMyStuff
       end
 
       # Flips the caller's approval to +approved+ from any other state (+pending+ or +rejected+). Only the approver
-      # themselves may call this. Fires +plan_my_stuff.issue.approval_granted+ and, when this flip completes the
-      # approval set, +plan_my_stuff.issue.all_approved+.
+      # themselves may call this. Fires +issue_approval_granted.plan_my_stuff+ and, when this flip completes the
+      # approval set, +issue_all_approved.plan_my_stuff+.
       #
       # @raise [PlanMyStuff::ValidationError] when the caller is not in the approvers list or is already approved
       #
@@ -109,9 +109,9 @@ module PlanMyStuff
       end
 
       # Flips the caller's approval to +rejected+ from any other state (+pending+ or +approved+). Only the approver
-      # themselves may call this. Fires +plan_my_stuff.issue.approval_rejected+ and, when this flip drops the issue
+      # themselves may call this. Fires +issue_approval_rejected.plan_my_stuff+ and, when this flip drops the issue
       # out of +fully_approved?+ (i.e. the caller was the last +approved+ approver),
-      # +plan_my_stuff.issue.approvals_invalidated+ (+trigger: :rejected+).
+      # +issue_approvals_invalidated.plan_my_stuff+ (+trigger: :rejected+).
       #
       # @raise [PlanMyStuff::ValidationError] when the caller is not in the approvers list or is already rejected
       #
@@ -147,9 +147,9 @@ module PlanMyStuff
       # may revoke any approver's response by passing +target_user_id:+. Non-support callers passing a
       # +target_user_id:+ that is not their own raise +AuthorizationError+.
       #
-      # Emits the granular event keyed off the source state: +plan_my_stuff.issue.approval_revoked+ from approved, or
-      # +plan_my_stuff.issue.rejection_revoked+ from rejected. When revoking an approval drops the issue out of
-      # +fully_approved?+, also fires +plan_my_stuff.issue.approvals_invalidated+ (+trigger: :revoked+). Revoking a
+      # Emits the granular event keyed off the source state: +issue_approval_revoked.plan_my_stuff+ from approved, or
+      # +issue_rejection_revoked.plan_my_stuff+ from rejected. When revoking an approval drops the issue out of
+      # +fully_approved?+, also fires +issue_approvals_invalidated.plan_my_stuff+ (+trigger: :revoked+). Revoking a
       # rejection cannot change +fully_approved?+ (the issue was already gated), so no aggregate event fires.
       #
       # @raise [PlanMyStuff::AuthorizationError] when a non-support caller targets another user
@@ -312,7 +312,7 @@ module PlanMyStuff
           return if added.empty?
 
           PlanMyStuff::Notifications.instrument(
-            'issue.approval_requested',
+            'issue_approval_requested',
             self,
             user: user,
             approvals: added,
@@ -333,7 +333,7 @@ module PlanMyStuff
         #
         def finish_state_change(event, approval, user:, was_fully_approved:, trigger: nil)
           PlanMyStuff::Notifications.instrument(
-            "issue.#{event}",
+            "issue_#{event}",
             self,
             user: user,
             approval: approval,
@@ -355,10 +355,10 @@ module PlanMyStuff
           now = fully_approved?
 
           if !was_fully_approved && now
-            PlanMyStuff::Notifications.instrument('issue.all_approved', self, user: user)
+            PlanMyStuff::Notifications.instrument('issue_all_approved', self, user: user)
           elsif was_fully_approved && !now && approvals_required?
             PlanMyStuff::Notifications.instrument(
-              'issue.approvals_invalidated',
+              'issue_approvals_invalidated',
               self,
               user: user,
               trigger: trigger,

data/lib/plan_my_stuff/issue_extractions/links.rb

@@ -210,7 +210,7 @@ module PlanMyStuff
       # 6. Closes self with +state_reason: :duplicate+ and
       #    +duplicate_of: { owner:, repo:, number: }+.
       # 7. Reloads self; invalidates link caches.
-      # 8. Fires +plan_my_stuff.issue.marked_duplicate+.
+      # 8. Fires +issue_marked_duplicate.plan_my_stuff+.
       #
       # Partial failures are not rolled back - GitHub retains whatever side effects succeeded before the failing step.
       #
@@ -232,7 +232,7 @@ module PlanMyStuff
 
         reload
         invalidate_links_cache!
-        PlanMyStuff::Notifications.instrument('issue.marked_duplicate', self, target: target_issue, user: user)
+        PlanMyStuff::Notifications.instrument('issue_marked_duplicate', self, target: target_issue, user: user)
 
         build_link!(target_issue, type: :duplicate_of)
       end
@@ -303,7 +303,7 @@ module PlanMyStuff
         end
 
         # Attempts the reciprocal write on +link+'s target. On failure, fires
-        # +plan_my_stuff.issue.link_reciprocal_failed+ so the consuming app can surface the half-written pairing.
+        # +issue_link_reciprocal_failed.plan_my_stuff+ so the consuming app can surface the half-written pairing.
         #
         # @param link [PlanMyStuff::Link]
         # @param user [Object, nil]
@@ -315,7 +315,7 @@ module PlanMyStuff
           yield(target)
         rescue PlanMyStuff::Error, Octokit::Error => e
           PlanMyStuff::Notifications.instrument(
-            'issue.link_reciprocal_failed',
+            'issue_link_reciprocal_failed',
             self,
             user: user,
             link: link,

data/lib/plan_my_stuff/issue_extractions/viewers.rb

@@ -6,7 +6,7 @@ module PlanMyStuff
       # Adds user IDs to this issue's visibility allowlist (non-support users whose ID is in the allowlist can see
       # internal comments).
       #
-      # Fires +plan_my_stuff.issue.viewers_added+.
+      # Fires +issue_viewers_added.plan_my_stuff+.
       #
       # @param user_ids [Array<Integer>, Integer]
       # @param user [Object, nil] actor for the notification event
@@ -16,13 +16,13 @@ module PlanMyStuff
       def add_viewers!(user_ids:, user: nil)
         ids = Array.wrap(user_ids)
         modify_allowlist! { |allowlist| allowlist | ids }
-        PlanMyStuff::Notifications.instrument('issue.viewers_added', self, user: user, user_ids: ids)
+        PlanMyStuff::Notifications.instrument('issue_viewers_added', self, user: user, user_ids: ids)
         metadata.visibility_allowlist
       end
 
       # Removes user IDs from this issue's visibility allowlist.
       #
-      # Fires +plan_my_stuff.issue.viewers_removed+.
+      # Fires +issue_viewers_removed.plan_my_stuff+.
       #
       # @param user_ids [Array<Integer>, Integer]
       # @param user [Object, nil] actor for the notification event
@@ -32,7 +32,7 @@ module PlanMyStuff
       def remove_viewers!(user_ids:, user: nil)
         ids = Array.wrap(user_ids)
         modify_allowlist! { |allowlist| allowlist - ids }
-        PlanMyStuff::Notifications.instrument('issue.viewers_removed', self, user: user, user_ids: ids)
+        PlanMyStuff::Notifications.instrument('issue_viewers_removed', self, user: user, user_ids: ids)
         metadata.visibility_allowlist
       end
 

data/lib/plan_my_stuff/issue_extractions/waiting.rb

@@ -55,7 +55,7 @@ module PlanMyStuff
       end
 
       # Reopens an issue that was auto-closed by the inactivity sweep, clears +metadata.closed_by_inactivity+, and
-      # emits +plan_my_stuff.issue.reopened_by_reply+ carrying the reopening comment. Does not emit the regular
+      # emits +issue_reopened_by_reply.plan_my_stuff+ carrying the reopening comment. Does not emit the regular
       # +issue.reopened+ event \- subscribers that specifically care about this flow subscribe to the dedicated event.
       #
       # @param comment [PlanMyStuff::Comment] the reopening comment
@@ -76,7 +76,7 @@ module PlanMyStuff
         reload
 
         PlanMyStuff::Notifications.instrument(
-          'issue.reopened_by_reply',
+          'issue_reopened_by_reply',
           self,
           user: user,
           comment: comment,

data/lib/plan_my_stuff/label.rb

@@ -28,7 +28,7 @@ module PlanMyStuff
         PlanMyStuff::Cache.delete_issue(issue.repo, issue.number)
 
         PlanMyStuff::Notifications.instrument(
-          'label.added', issue, user: user, labels: label_names,
+          'label_added', issue, user: user, labels: label_names,
         )
 
         result.map { |gh_label| build(gh_label, issue: issue) }
@@ -90,7 +90,7 @@ module PlanMyStuff
         PlanMyStuff::Cache.delete_issue(issue.repo, issue.number)
 
         PlanMyStuff::Notifications.instrument(
-          'label.removed', issue, user: user, labels: label_names,
+          'label_removed', issue, user: user, labels: label_names,
         )
 
         results

data/lib/plan_my_stuff/notifications.rb

@@ -7,18 +7,20 @@ module PlanMyStuff
   # +PlanMyStuff::Notifications.instrument+ at mutation points so
   # consuming apps can subscribe for email, webhooks, Slack, etc.
   #
-  # Events are fired under the +plan_my_stuff.<event>+ namespace via
-  # +ActiveSupport::Notifications+. Subscribers run synchronously.
+  # Events are fired under the +<event>.plan_my_stuff+ namespace via
+  # +ActiveSupport::Notifications+ (Rails convention: event first,
+  # library last - matches +sql.active_record+, +deliver.action_mailer+).
+  # Subscribers run synchronously.
   #
   module Notifications
     module_function
 
-    EVENT_PREFIX = 'plan_my_stuff'
+    EVENT_SUFFIX = 'plan_my_stuff'
     SKIPPED_LOG_KEYS = %i[user timestamp visibility visibility_allowlist].freeze
 
-    # Fires +plan_my_stuff.<event>+ with a normalized payload.
+    # Fires +<event>.plan_my_stuff+ with a normalized payload.
     #
-    # @param event [String] e.g. +'issue.created'+
+    # @param event [String] e.g. +'issue_created'+
     # @param resource [Object] domain object (+Issue+, +Comment+, +ProjectItem+, ...)
     # @param user [Object, nil] explicit actor; falls back to +config.current_user+
     # @param extra [Hash] additional payload entries (+changes:+, +labels:+, +user_ids:+, ...)
@@ -29,7 +31,7 @@ module PlanMyStuff
       actor = user || resolve_current_user
       payload = build_payload(resource, actor, extra)
       log(event, payload)
-      ActiveSupport::Notifications.instrument("#{EVENT_PREFIX}.#{event}", payload)
+      ActiveSupport::Notifications.instrument("#{event}.#{EVENT_SUFFIX}", payload)
     end
 
     # Invokes +config.current_user+ if it responds to +call+.
@@ -113,7 +115,7 @@ module PlanMyStuff
       logger = rails_logger
       return if logger.nil?
 
-      logger.debug { "[PlanMyStuff] #{EVENT_PREFIX}.#{event} #{log_fields(payload)}" }
+      logger.debug { "[PlanMyStuff] #{event}.#{EVENT_SUFFIX} #{log_fields(payload)}" }
     end
 
     # @return [Logger, nil]

data/lib/plan_my_stuff/pipeline/completed_sweep.rb

@@ -7,7 +7,7 @@ module PlanMyStuff
     #
     # Driven by +RemindersSweepJob+ so the gem ships one scheduled
     # entrypoint. Items are removed via +Pipeline.remove!+ so subscribers
-    # see the standard +plan_my_stuff.pipeline.removed+ event.
+    # see the standard +pipeline_removed.plan_my_stuff+ event.
     #
     module CompletedSweep
       module_function

data/lib/plan_my_stuff/pipeline.rb

@@ -49,7 +49,7 @@ module PlanMyStuff
       PlanMyStuff.configuration.pipeline_statuses.fetch(canonical, canonical)
     end
 
-    # Fires a +plan_my_stuff.pipeline.<event>+ notification.
+    # Fires a +pipeline_<event>.plan_my_stuff+ notification.
     #
     # When +event+ is a canonical +Pipeline::Status+ name, the event key is derived via +Status.key_for+ and the
     # canonical status is added to the payload as +:status+. Otherwise +event+ is used verbatim as the suffix (e.g.
@@ -70,7 +70,7 @@ module PlanMyStuff
       end
 
       PlanMyStuff::Notifications.instrument(
-        "pipeline.#{event_to_use}",
+        "pipeline_#{event_to_use}",
         project_item,
         issue_number: project_item.number,
         **extra_to_use,
@@ -98,7 +98,7 @@ module PlanMyStuff
     # Removes a project item from the pipeline project entirely. Captures the prior status before deletion so
     # subscribers can decide whether the removal happened late in the lifecycle.
     #
-    # Always fires +plan_my_stuff.pipeline.removed+. Additionally fires +plan_my_stuff.pipeline.removed_late+ when
+    # Always fires +pipeline_removed.plan_my_stuff+. Additionally fires +pipeline_removed_late.plan_my_stuff+ when
     # +prior_status+ is past "Started" (i.e. anything other than "Started", accounting for configured status aliases).
     # +nil+ status is treated as not-late.
     #

data/lib/plan_my_stuff/reminders/closer.rb

@@ -4,7 +4,7 @@ module PlanMyStuff
   module Reminders
     # Auto-closes a waiting issue that has exceeded the configured
     # +inactivity_close_days+ ceiling. Clears waiting state and emits a
-    # dedicated +plan_my_stuff.issue.closed_inactive+ event.
+    # dedicated +issue_closed_inactive.plan_my_stuff+ event.
     #
     # Goes through +Issue#update!+ with +skip_notification: true+ so the
     # regular +issue.closed+ event is suppressed in favor of the
@@ -37,7 +37,7 @@ module PlanMyStuff
 
       # Closes the issue, tags it with the configured
       # +user_inactive_label+, then emits
-      # +plan_my_stuff.issue.closed_inactive+.
+      # +issue_closed_inactive.plan_my_stuff+.
       #
       # @return [void]
       #
@@ -49,7 +49,7 @@ module PlanMyStuff
         )
         add_user_inactive_label
         PlanMyStuff::Notifications.instrument(
-          'issue.closed_inactive',
+          'issue_closed_inactive',
           @issue,
           reason: :inactivity,
         )

data/lib/plan_my_stuff/reminders/fire.rb

@@ -2,7 +2,7 @@
 
 module PlanMyStuff
   module Reminders
-    # Emits +plan_my_stuff.issue.reminder_due+ for a single waiting issue
+    # Emits +issue_reminder_due.plan_my_stuff+ for a single waiting issue
     # and advances its +next_reminder_at+ to the next milestone in the
     # effective +reminder_days+ schedule (or +nil+ when the last milestone
     # has passed).
@@ -34,7 +34,7 @@ module PlanMyStuff
       #
       def call
         payload = build_payload
-        PlanMyStuff::Notifications.instrument('issue.reminder_due', @issue, **payload)
+        PlanMyStuff::Notifications.instrument('issue_reminder_due', @issue, **payload)
 
         @issue.update!(
           metadata: { next_reminder_at: next_reminder_at_value },

data/lib/plan_my_stuff/test_helpers.rb

@@ -177,7 +177,7 @@ module PlanMyStuff
       end
     end
 
-    # Captures +plan_my_stuff.*+ +ActiveSupport::Notifications+ events fired
+    # Captures +*.plan_my_stuff+ +ActiveSupport::Notifications+ events fired
     # inside the given block. Lets consuming apps assert that their code
     # triggers gem events without threading subscriptions through every spec.
     #
@@ -186,7 +186,7 @@ module PlanMyStuff
     #   events = PlanMyStuff::TestHelpers::Notifications.capture do
     #     PlanMyStuff::Issue.create!(...)
     #   end
-    #   events.first[:name]    # => "plan_my_stuff.issue.created"
+    #   events.first[:name]    # => "issue_created.plan_my_stuff"
     #   events.first[:payload] # => { issue:, user:, timestamp:, ... }
     #
     module Notifications
@@ -196,7 +196,7 @@ module PlanMyStuff
       def capture(&)
         events = []
         callback = -> (name, _start, _finish, _id, payload) { events << { name: name, payload: payload } }
-        ActiveSupport::Notifications.subscribed(callback, /^plan_my_stuff\./, &)
+        ActiveSupport::Notifications.subscribed(callback, /\.plan_my_stuff\z/, &)
         events
       end
     end
@@ -708,11 +708,11 @@ module PlanMyStuff
 end
 
 if defined?(RSpec::Matchers)
-  # Asserts that a +plan_my_stuff.<name>+ event was fired inside the block.
+  # Asserts that a +<name>.plan_my_stuff+ event was fired inside the block.
   # Chain +.with(key: value, ...)+ to match on a payload subset.
   #
-  #   expect { Issue.create!(...) }.to(have_fired_event('plan_my_stuff.issue.created'))
-  #   expect { Issue.create!(...) }.to(have_fired_event('plan_my_stuff.issue.created').with(user: alice))
+  #   expect { Issue.create!(...) }.to(have_fired_event('issue_created.plan_my_stuff'))
+  #   expect { Issue.create!(...) }.to(have_fired_event('issue_created.plan_my_stuff').with(user: alice))
   #
   RSpec::Matchers.define(:have_fired_event) do |event_name|
     supports_block_expectations

data/lib/plan_my_stuff/version.rb

@@ -3,7 +3,7 @@
 module PlanMyStuff
   module VERSION
     MAJOR = 0
-    MINOR = 14
+    MINOR = 15
     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.14.0
+  version: 0.15.0
 platform: ruby
 authors:
 - Brands Insurance