plan_my_stuff 0.24.0 → 0.25.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1cf33c92cfa763f5ace87a1419cf8c7369f27e8adc10d1c092c044b99d151a4a
-  data.tar.gz: 3b2a482534b9f9094d550385c064f50f4dc37db3c2a6361e4aa899d4b4dc5713
+  metadata.gz: 64667e99c4a5b732a987a483072636d81c8d36840433feaf83f4d89b71f96934
+  data.tar.gz: 4675d511991935756e77c8730c57588bcbea68fd48acecfc67753c2062cd48ab
 SHA512:
-  metadata.gz: ef36dbcfb77d4c3763d2165993c50fb9f4f7e8b0729a1efc1d63fb9155abb039bf9db92fb59a49d3302ebfec024bafc19dd15b54be84a2d7919040405a10803f
-  data.tar.gz: beae8f4926a95e4a47786c4ffefc886300f255466d7e08a7e607f444e91883e920b3bf60d666d33b539eed2dac7a1241f64cd23ae42ebe292a8a113ce150de8d
+  metadata.gz: 2393fea9842e2c1ee5656f4123416933b0021ba5fcdf80962ddc1e15ea72f12682dbd353cde0f8931066eb2a656be4a34bcf8a6c7ab886e200c52df66c30876b
+  data.tar.gz: 3aea3806e8ca62fc0de5bf2b94544f0cb5888c3a20a224e8104b85f4d99095715d845e4509a80930c9eb2d9652a16b05151c659b53b19eda3e8f77ce6b5e7bb6

data/CHANGELOG.md

@@ -1,5 +1,16 @@
 # Changelog
 
+## 0.25.0
+
+### Added
+
+- `PlanMyStuff::Pipeline.clear_testing!(project_item, user: nil)` - reverses `request_testing!` by writing the
+  `:inactive` Testing field value. Fires `pipeline_testing_cleared.plan_my_stuff` with `field_name`, `value`,
+  `user` payload.
+- `PlanMyStuff::Issues::TestingsController` + `POST/DELETE /issues/:issue_id/testing` route (gated on
+  `config.pipeline_enabled`). Backs new "Request testing" / "Clear testing" buttons on the issue show view
+  (closes #52).
+
 ## 0.24.0
 
 ### Added

data/CONFIGURATION.md

@@ -392,6 +392,7 @@ Controllable keys (with gem defaults):
 | `:'issues/closures'` | `plan_my_stuff/issues/closures` |
 | `:'issues/viewers'` | `plan_my_stuff/issues/viewers` |
 | `:'issues/takes'` | `plan_my_stuff/issues/takes` |
+| `:'issues/testings'` | `plan_my_stuff/issues/testings` |
 | `:'issues/waitings'` | `plan_my_stuff/issues/waitings` |
 | `:'issues/links'` | `plan_my_stuff/issues/links` |
 | `:'issues/approvals'` | `plan_my_stuff/issues/approvals` |

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

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module PlanMyStuff
+  module Issues
+    # Toggles the pipeline +Testing+ custom field on an issue's project item via
+    # +PlanMyStuff::Pipeline.request_testing!+ and +PlanMyStuff::Pipeline.clear_testing!+. Backs the "Request testing" /
+    # "Clear testing" buttons on the mounted issue show view.
+    #
+    # POST   /issues/:issue_id/testing -> create  (flips +Testing+ to its active value)
+    # DELETE /issues/:issue_id/testing -> destroy (flips +Testing+ back to inactive)
+    #
+    class TestingsController < PlanMyStuff::ApplicationController
+      before_action :require_support_user
+
+      # POST /issues/:issue_id/testing
+      def create
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
+        project_item = find_project_item!(issue)
+
+        PlanMyStuff::Pipeline.request_testing!(project_item, user: pms_current_user)
+
+        yield(project_item) if block_given?
+        return if performed?
+
+        flash[:success] = "Issue ##{issue.number} marked as in testing."
+        redirect_to(plan_my_stuff.issue_path(issue))
+      rescue ArgumentError, PlanMyStuff::Error => e
+        pms_handle_rescue(e)
+        flash[:error] = e.message
+        redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
+      end
+
+      # DELETE /issues/:issue_id/testing
+      def destroy
+        issue = PlanMyStuff::Issue.find(params[:issue_id])
+        project_item = find_project_item!(issue)
+
+        PlanMyStuff::Pipeline.clear_testing!(project_item, user: pms_current_user)
+
+        yield(project_item) if block_given?
+        return if performed?
+
+        flash[:success] = "Issue ##{issue.number} testing cleared."
+        redirect_to(plan_my_stuff.issue_path(issue))
+      rescue ArgumentError, PlanMyStuff::Error => e
+        pms_handle_rescue(e)
+        flash[:error] = e.message
+        redirect_to(plan_my_stuff.issue_path(params[:issue_id]))
+      end
+
+      private
+
+        # Redirects non-support users back to the issue page. Mirrors +Issues::TakesController+'s authorization check.
+        #
+        # @return [void]
+        #
+        def require_support_user
+          return if support_user?
+
+          redirect_to_unauthorized(
+            plan_my_stuff.issue_path(params[:issue_id]),
+          )
+        end
+
+        # Looks up the pipeline project item for the issue, raising if missing. Defensive against a stale view (button
+        # rendered before the item was removed) or a race with another tab removing the issue from the pipeline.
+        #
+        # @raise [PlanMyStuff::Error] if the issue is not in the pipeline
+        #
+        # @param issue [PlanMyStuff::Issue]
+        #
+        # @return [PlanMyStuff::ProjectItem]
+        #
+        def find_project_item!(issue)
+          project_item = PlanMyStuff::Pipeline::IssueLinker.find_project_item(issue.number)
+          return project_item if project_item.present?
+
+          raise(PlanMyStuff::Error, "Issue ##{issue.number} is not in the pipeline.")
+        end
+    end
+  end
+end

data/app/views/plan_my_stuff/issues/show.html.erb

@@ -20,9 +20,24 @@
   <% if @support_user && @pipeline_enabled && @pipeline_item.nil? && @issue.assignees.blank? %>
     <%= 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) %>
+  <%
+    show_unassign =
+      @support_user &&
+      @pipeline_enabled &&
+      @current_user_login.present? &&
+      @issue.assignees.include?(@current_user_login)
+  %>
+  <% if show_unassign %>
     <%= button_to('Unassign', plan_my_stuff.issue_take_path(@issue), method: :delete) %>
   <% end %>
+  <% if @support_user && @pipeline_enabled && @pipeline_item.present? %>
+    <% testing_value = @pipeline_item.field_values[PlanMyStuff.configuration.pipeline_testing_field_name] %>
+    <% if testing_value == PlanMyStuff.configuration.pipeline_testing_values[:active] %>
+      <%= button_to('Clear testing', plan_my_stuff.issue_testing_path(@issue), method: :delete) %>
+    <% else %>
+      <%= button_to('Request testing', plan_my_stuff.issue_testing_path(@issue), method: :post) %>
+    <% end %>
+  <% end %>
   <% if @support_user %>
     <%= link_to('Start Testing Project', plan_my_stuff.new_testing_project_path(subject_url: @issue.html_url)) %>
   <% end %>

data/config/routes.rb

@@ -15,6 +15,11 @@ PlanMyStuff::Engine.routes.draw do
           only: %i[create destroy],
           controller: config.controller_for(:'issues/takes'),
         )
+        resource(
+          :testing,
+          only: %i[create destroy],
+          controller: config.controller_for(:'issues/testings'),
+        )
       end
       resources :comments, only: %i[create edit update], controller: config.controller_for(:comments)
       resources :labels, only: %i[create destroy], controller: config.controller_for(:labels)

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

@@ -348,6 +348,7 @@ PlanMyStuff.configure do |config|
   #   :'issues/closures'                => 'plan_my_stuff/issues/closures'
   #   :'issues/viewers'                 => 'plan_my_stuff/issues/viewers'
   #   :'issues/takes'                   => 'plan_my_stuff/issues/takes'
+  #   :'issues/testings'                => 'plan_my_stuff/issues/testings'
   #   :'issues/waitings'                => 'plan_my_stuff/issues/waitings'
   #   :'issues/links'                   => 'plan_my_stuff/issues/links'
   #   :'issues/approvals'               => 'plan_my_stuff/issues/approvals'

data/lib/plan_my_stuff/configuration.rb

@@ -18,6 +18,7 @@ module PlanMyStuff
       'issues/closures': 'plan_my_stuff/issues/closures',
       'issues/viewers': 'plan_my_stuff/issues/viewers',
       'issues/takes': 'plan_my_stuff/issues/takes',
+      'issues/testings': 'plan_my_stuff/issues/testings',
       'issues/waitings': 'plan_my_stuff/issues/waitings',
       'issues/links': 'plan_my_stuff/issues/links',
       'issues/approvals': 'plan_my_stuff/issues/approvals',

data/lib/plan_my_stuff/pipeline.rb

@@ -200,6 +200,25 @@ module PlanMyStuff
       result
     end
 
+    # Reverses +request_testing!+ by flipping the +Testing+ custom single-select field back to its inactive value.
+    # Not approval-gated -- the forward transition (+request_testing!+) was already gated, so clearing should always
+    # succeed (matches +remove!+).
+    #
+    # @param project_item [PlanMyStuff::ProjectItem]
+    # @param user [Object, nil] actor forwarded to the +pipeline_testing_cleared.plan_my_stuff+ payload
+    #
+    # @return [Hash] mutation result
+    #
+    def clear_testing!(project_item, user: nil)
+      field_name = PlanMyStuff.configuration.pipeline_testing_field_name
+      value = PlanMyStuff.configuration.pipeline_testing_values.fetch(:inactive)
+      result = project_item.update_single_select_field!(field_name, value)
+
+      instrument('testing_cleared', project_item, field_name: field_name, value: value, user: user)
+
+      result
+    end
+
     # Moves a project item to "Ready for Release".
     #
     # @param project_item [PlanMyStuff::ProjectItem]

data/lib/plan_my_stuff/version.rb

@@ -3,7 +3,7 @@
 module PlanMyStuff
   module VERSION
     MAJOR = 0
-    MINOR = 24
+    MINOR = 25
     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.24.0
+  version: 0.25.0
 platform: ruby
 authors:
 - Brands Insurance
@@ -61,6 +61,7 @@ files:
 - app/controllers/plan_my_stuff/issues/closures_controller.rb
 - app/controllers/plan_my_stuff/issues/links_controller.rb
 - app/controllers/plan_my_stuff/issues/takes_controller.rb
+- app/controllers/plan_my_stuff/issues/testings_controller.rb
 - app/controllers/plan_my_stuff/issues/viewers_controller.rb
 - app/controllers/plan_my_stuff/issues/waitings_controller.rb
 - app/controllers/plan_my_stuff/issues_controller.rb