plan_my_stuff 0.22.0 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d44fbaa2722319a0d586bf8f947222aa76f74462b5516f516f34b87b89ff6211
-  data.tar.gz: 05eaab50eaca5856a19cd68f796b1b4170cb750a6bb8c78566c003a576707122
+  metadata.gz: e6c0f0590ab0ae66923b771acd03e238d78ed2b535a24efc1ad8047774874914
+  data.tar.gz: 991920b03d4f7b2417ed51c213c0b3a9368772dbc552d5d1f17d80a512207b94
 SHA512:
-  metadata.gz: afbbeca592468025940d1b98eae3c93da09ca79a5406afe5d500f93e8d1803c59d8ced137c81b1e05297678de17920681756983cd0b2a4c253900897f4d5d9b5
-  data.tar.gz: 95ca844953334f3d514c1b530cac5837307b3b735975c18256ab09ad408e1e4aea1f964de8d43ffe4c6b74bdf17284f93d8f114f7e47c4ecb37484023278b28e
+  metadata.gz: 712c0847e85926474c0331211de128e1732e99672f79cf4cc56f6ec3313ab814b0bef15cfa3c51d360d78abac5f99825c20ec29be9aa274265a37ea271648293
+  data.tar.gz: 153ecbe20c5bcc2c9d5b25cf85ded6fbe27ca6ea6b881e9b1e62bf04e3c538e5baf50e604f97092ec9f741bfc9cc0cbb29ea72bc86f42fb879ac0d91fb7e5180

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # Changelog
 
+## 0.23.0
+
+### Added
+
+- `PlanMyStuff::Pipeline.take!` and `PlanMyStuff::Pipeline.request_testing!` now accept a `user:` kwarg
+  that is forwarded onto the `pipeline_started.plan_my_stuff` / `pipeline_testing.plan_my_stuff`
+  `ActiveSupport::Notifications` payload. Defaults to `nil`, falling back to
+  `config.current_user` via `PlanMyStuff::Notifications.resolve_current_user`.
+
 ## 0.22.0
 
 ### Added

data/lib/plan_my_stuff/pipeline.rb

@@ -153,15 +153,16 @@ module PlanMyStuff
     # Moves a project item to "Started".
     #
     # @param project_item [PlanMyStuff::ProjectItem]
+    # @param user [Object, nil] actor forwarded to the +pipeline_started.plan_my_stuff+ payload
     #
     # @return [Hash] mutation result
     #
-    def take!(project_item)
+    def take!(project_item, user: nil)
       guard_approvals!(project_item&.issue)
       status = resolve_status_name(PlanMyStuff::Pipeline::Status::STARTED)
       result = project_item.move_to!(status)
 
-      instrument(PlanMyStuff::Pipeline::Status::STARTED, project_item)
+      instrument(PlanMyStuff::Pipeline::Status::STARTED, project_item, user: user)
       result
     end
 
@@ -184,16 +185,17 @@ module PlanMyStuff
     # NOT change the item's +Status+ -- testing runs orthogonally to +In Review+.
     #
     # @param project_item [PlanMyStuff::ProjectItem]
+    # @param user [Object, nil] actor forwarded to the +pipeline_testing.plan_my_stuff+ payload
     #
     # @return [Hash] mutation result
     #
-    def request_testing!(project_item)
+    def request_testing!(project_item, user: nil)
       guard_approvals!(project_item&.issue)
       field_name = PlanMyStuff.configuration.pipeline_testing_field_name
       value = PlanMyStuff.configuration.pipeline_testing_values.fetch(:active)
       result = project_item.update_single_select_field!(field_name, value)
 
-      instrument('testing', project_item, field_name: field_name, value: value)
+      instrument('testing', project_item, field_name: field_name, value: value, user: user)
 
       result
     end

data/lib/plan_my_stuff/test_helpers.rb

@@ -618,12 +618,13 @@ module PlanMyStuff
           take! mark_in_review! request_testing! mark_ready_for_release! start_deployment! complete_deployment!
         ].each { |m| save_original(pipeline_mod, m) }
 
-        pipeline_mod.define_singleton_method(:take!) do |project_item|
+        pipeline_mod.define_singleton_method(:take!) do |project_item, user: nil|
           PlanMyStuff::TestHelpers.recorded_actions << {
             type: :pipeline_started,
             params: {
               item_id: project_item.respond_to?(:id) ? project_item.id : nil,
               issue_number: project_item.respond_to?(:number) ? project_item.number : nil,
+              user: user,
             },
           }
 
@@ -642,7 +643,7 @@ module PlanMyStuff
           nil
         end
 
-        pipeline_mod.define_singleton_method(:request_testing!) do |project_item|
+        pipeline_mod.define_singleton_method(:request_testing!) do |project_item, user: nil|
           field_name = PlanMyStuff.configuration.pipeline_testing_field_name
           value = PlanMyStuff.configuration.pipeline_testing_values.fetch(:active)
 
@@ -653,6 +654,7 @@ module PlanMyStuff
               issue_number: project_item.respond_to?(:number) ? project_item.number : nil,
               field_name: field_name,
               value: value,
+              user: user,
             },
           }
 

data/lib/plan_my_stuff/version.rb

@@ -3,7 +3,7 @@
 module PlanMyStuff
   module VERSION
     MAJOR = 0
-    MINOR = 22
+    MINOR = 23
     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.22.0
+  version: 0.23.0
 platform: ruby
 authors:
 - Brands Insurance