plan_my_stuff 0.21.1 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4eda8634e75b318cd847d512405f71d4ffe2b0d7a6beccd6404912a6c64f1c2b
-  data.tar.gz: 80c7edb2a0e861c3dc0f76b06ae23232bde0ed52d04f4cdada69bd29aa8107dd
+  metadata.gz: e6c0f0590ab0ae66923b771acd03e238d78ed2b535a24efc1ad8047774874914
+  data.tar.gz: 991920b03d4f7b2417ed51c213c0b3a9368772dbc552d5d1f17d80a512207b94
 SHA512:
-  metadata.gz: 3336630d6d5ee6b8bad51fdfa08a647aa58933e0f30a36241fd137a4d3f5b67656386d36fd0990d289499a7cf2643469e32c1642d4f2d5811be5fc671ea9d420
-  data.tar.gz: 15db293bc2203d60ca7e2b5d102035b1a8d064a74b84666e13d0fbcad1ab15dbe576f02af2f7582c56c9f65246dbb23e41043f6036e304801722c40890c463fc
+  metadata.gz: 712c0847e85926474c0331211de128e1732e99672f79cf4cc56f6ec3313ab814b0bef15cfa3c51d360d78abac5f99825c20ec29be9aa274265a37ea271648293
+  data.tar.gz: 153ecbe20c5bcc2c9d5b25cf85ded6fbe27ca6ea6b881e9b1e62bf04e3c538e5baf50e604f97092ec9f741bfc9cc0cbb29ea72bc86f42fb879ac0d91fb7e5180

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # 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
+
+- `Issue#add_to_priority_list!(priority:)` and `Issue#remove_from_priority_list!` - first-class setters that
+  mirror the `#priority_list?` / `#priority_list_priority` readers. Each writes both `Priority List` and
+  `Priority List Priority` in a single mutation so the two fields cannot drift apart (closes #80).
+
+### Changed
+
+- `IssueMetadata#priority_list` / `#priority_list_priority` deprecation message now points callers at the new
+  `Issue#add_to_priority_list!` / `#remove_from_priority_list!` pair instead of raw `set_issue_fields!`.
+
 ## 0.21.1
 
 ### Added

data/lib/plan_my_stuff/issue.rb

@@ -842,6 +842,35 @@ module PlanMyStuff
       issue_fields['Priority List Priority']
     end
 
+    # Adds this issue to the Priority List at the given priority (or re-prioritizes if already listed). Sets
+    # +Priority List+ and +Priority List Priority+ together in a single +setIssueFieldValue+ mutation so the two
+    # fields never drift out of sync.
+    #
+    # @raise [PlanMyStuff::IssueFieldsNotEnabledError] when +config.issue_fields_enabled+ is +false+
+    #
+    # @param priority [Integer]
+    #
+    # @return [self]
+    #
+    def add_to_priority_list!(priority:)
+      raise(ArgumentError, 'Priority must be an integer') unless priority.is_a?(Integer)
+
+      set_issue_fields!('Priority List' => 'Yes', 'Priority List Priority' => priority)
+    end
+
+    alias update_priority_list_priority! add_to_priority_list!
+
+    # Removes this issue from the Priority List. Clears both +Priority List+ and +Priority List Priority+ in a single
+    # +setIssueFieldValue+ mutation so the two fields never drift out of sync.
+    #
+    # @raise [PlanMyStuff::IssueFieldsNotEnabledError] when +config.issue_fields_enabled+ is +false+
+    #
+    # @return [self]
+    #
+    def remove_from_priority_list!
+      set_issue_fields!('Priority List' => nil, 'Priority List Priority' => nil)
+    end
+
     # Bulk-updates GitHub Issue Field values in a single +setIssueFieldValue+ mutation. Each key is the field display
     # name; values are coerced to the right input fragment based on the field's type. Passing +nil+ as a value clears
     # that field.

data/lib/plan_my_stuff/issue_metadata.rb

@@ -5,7 +5,8 @@ module PlanMyStuff
     PRIORITY_LIST_METADATA_DEPRECATION =
       'PlanMyStuff: IssueMetadata#priority_list / #priority_list_priority are deprecated. priority_list moved to ' \
         "GitHub Issue Fields ('Priority List' single_select, 'Priority List Priority' number) in 0.20.0. Reads " \
-        'now come from issue_fields; legacy writes forward to set_issue_fields! on save. The metadata accessors ' \
+        'now come from Issue#priority_list? / #priority_list_priority; for writes, use ' \
+        'Issue#add_to_priority_list!(priority: N) and Issue#remove_from_priority_list!. The metadata accessors ' \
         'will be removed in 1.0.0.'
 
     # @return [Time, nil] first support action timestamp, nil until set
@@ -201,7 +202,7 @@ module PlanMyStuff
       @priority_list
     end
 
-    # @deprecated Use +Issue#update!(issue_fields: { 'Priority List' => 'Yes' })+. Removed in 1.0.0.
+    # @deprecated Use +Issue#add_to_priority_list!(priority: N)+ / +Issue#remove_from_priority_list!+. Removed in 1.0.0.
     #
     # @param value [Object]
     #
@@ -231,7 +232,7 @@ module PlanMyStuff
       @priority_list_priority
     end
 
-    # @deprecated Use +Issue#update!(issue_fields: { 'Priority List Priority' => N })+. Removed in 1.0.0.
+    # @deprecated Use +Issue#add_to_priority_list!(priority: N)+ / +Issue#remove_from_priority_list!+. Removed in 1.0.0.
     #
     # @param value [Object]
     #

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,8 +3,8 @@
 module PlanMyStuff
   module VERSION
     MAJOR = 0
-    MINOR = 21
-    TINY = 1
+    MINOR = 23
+    TINY = 0
 
     # Set PRE to nil unless it's a pre-release (beta, rc, etc.)
     PRE = nil

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: plan_my_stuff
 version: !ruby/object:Gem::Version
-  version: 0.21.1
+  version: 0.23.0
 platform: ruby
 authors:
 - Brands Insurance