[#71059] Add sprint goal CRUD to modal

Goal text field in the sprint dialog, with shared-sprint
banners and permission-based field enable/disable. Create
and update services persist goal as a `SprintGoal` row
via `after_perform`.

https://community.openproject.org/wp/71059

Author: myabc

modules/backlogs/app/components/backlogs/sprint_dialog_component.html.erb

@@ -38,7 +38,7 @@ See COPYRIGHT and LICENSE files for more details.
     d.with_header(variant: :large)
 
     d.with_body do
-      render(Backlogs::SprintFormComponent.new(sprint: @sprint))
+      render(Backlogs::SprintFormComponent.new(sprint: @sprint, project: @project))
     end
 
     d.with_footer do

modules/backlogs/app/components/backlogs/sprint_dialog_component.rb

@@ -41,14 +41,15 @@ class SprintDialogComponent < ApplicationComponent
     STATE_DEFAULT = :create
     STATE_OPTIONS = [STATE_DEFAULT, :edit].freeze
 
-    attr_reader :sprint, :state
+    attr_reader :sprint, :project, :state
 
     delegate :create?, :edit?, to: :state
 
-    def initialize(sprint:, state: STATE_DEFAULT)
+    def initialize(sprint:, project:, state: STATE_DEFAULT)
       super
 
       @sprint = sprint
+      @project = project
       @state = ActiveSupport::StringInquirer.new(fetch_or_fallback(STATE_OPTIONS, state, STATE_DEFAULT).to_s)
     end
 

modules/backlogs/app/components/backlogs/sprint_form_component.html.erb

@@ -44,11 +44,34 @@ See COPYRIGHT and LICENSE files for more details.
             render(Primer::Alpha::Banner.new(mb: 3, icon: :stop, scheme: :danger)) { base_errors.join("\n") }
           end
         end
+        if shared_sprint?
+          flex.with_row(mb: 3) do
+            render(Primer::Alpha::Banner.new(
+              scheme: banner_scheme,
+              icon: banner_scheme == :warning ? :alert : :info
+            )) { banner_text }
+          end
+        end
         flex.with_row(mb: 3) do
-          render Backlogs::Sprints::DetailsForm.new(f)
+          render Backlogs::Sprints::DetailsForm.new(f, disabled: !can_edit_sprint?)
         end
         flex.with_row(classes: "FormControl-horizontalGroup--sm-vertical") do
-          render Backlogs::Sprints::DatesForm.new(f)
+          render Backlogs::Sprints::DatesForm.new(f, disabled: !can_edit_sprint?)
+        end
+        if shared_sprint?
+          flex.with_row(my: 3) do
+            render(Primer::BaseComponent.new(tag: :hr, border_color: :muted))
+          end
+        end
+        flex.with_row(mb: 3) do
+          render(Primer::Alpha::TextField.new(
+            name: "sprint[goal]",
+            label: goal_label,
+            value: goal_value,
+            caption: goal_caption,
+            disabled: !can_edit_goal?,
+            full_width: true
+          ))
         end
       end
     end

modules/backlogs/app/components/backlogs/sprint_form_component.rb

@@ -37,15 +37,59 @@ class SprintFormComponent < ApplicationComponent
 
     FORM_ID = SprintDialogComponent::FORM_ID
 
-    attr_reader :sprint, :base_errors
+    attr_reader :sprint, :project, :current_user, :base_errors
 
-    def initialize(sprint:, base_errors: nil)
+    def initialize(sprint:, project:, current_user: User.current, base_errors: nil)
       super
 
       @sprint = sprint
+      @project = project
+      @current_user = current_user
       @base_errors = base_errors
     end
 
+    def shared_sprint?
+      sprint.persisted? && !sprint.owned_by?(project)
+    end
+
+    def can_edit_sprint?
+      return true unless shared_sprint?
+
+      current_user.allowed_in_project?(:create_sprints, sprint.project)
+    end
+
+    def can_edit_goal?
+      return true unless shared_sprint?
+
+      current_user.allowed_in_project?(:create_sprints, project)
+    end
+
+    def banner_scheme
+      can_edit_sprint? ? :default : :warning
+    end
+
+    def banner_text
+      if can_edit_sprint?
+        I18n.t("backlogs.sprint_form.shared_sprint_info_banner")
+      else
+        I18n.t("backlogs.sprint_form.shared_sprint_warning_banner")
+      end
+    end
+
+    def goal_label
+      label = Sprint.human_attribute_name(:goal)
+      label += " #{I18n.t('backlogs.sprint_form.goal_for_this_project_suffix')}" if shared_sprint?
+      label
+    end
+
+    def goal_caption
+      I18n.t("backlogs.sprint_form.goal_caption") if shared_sprint?
+    end
+
+    def goal_value
+      sprint.goal_for(project)&.goal
+    end
+
     private
 
     def http_verb

modules/backlogs/app/controllers/backlogs/sprints_controller.rb

@@ -52,13 +52,13 @@ def new_dialog
         contract_class: ::EmptyContract
       ).call(attributes: converted_sprint_params)
 
-      respond_with_dialog Backlogs::SprintDialogComponent.new(sprint: call.result)
+      respond_with_dialog Backlogs::SprintDialogComponent.new(sprint: call.result, project: @project)
     end
 
     def edit_dialog
       @sprint = Sprint.for_project(@project).visible.find(params[:sprint_id])
 
-      respond_with_dialog Backlogs::SprintDialogComponent.new(sprint: @sprint, state: :edit)
+      respond_with_dialog Backlogs::SprintDialogComponent.new(sprint: @sprint, project: @project, state: :edit)
     end
 
     def refresh_form
@@ -71,15 +71,15 @@ def refresh_form
         contract_class: ::EmptyContract
       ).call(attributes: converted_sprint_params)
 
-      update_via_turbo_stream(component: Backlogs::SprintFormComponent.new(sprint: call.result))
+      update_via_turbo_stream(component: Backlogs::SprintFormComponent.new(sprint: call.result, project: @project))
 
       respond_with_turbo_streams
     end
 
     def create # rubocop:disable Metrics/AbcSize
       call = ::Sprints::CreateService
                .new(user: current_user)
-               .call(attributes: converted_sprint_params)
+               .call(attributes: converted_sprint_params, goal: goal_param)
 
       if call.success?
         flash[:notice] = I18n.t(:notice_successful_create)
@@ -93,7 +93,7 @@ def create # rubocop:disable Metrics/AbcSize
     def update
       call = ::Sprints::UpdateService
                .new(user: current_user, model: @sprint)
-               .call(attributes: sprint_params[:sprint])
+               .call(attributes: sprint_update_params, goal: goal_param, goal_project: @project)
 
       if call.success?
         render_success_flash_message_via_turbo_stream(message: I18n.t(:notice_successful_update))
@@ -145,6 +145,7 @@ def update_sprint_form_component_via_turbo_stream(sprint:, base_errors: nil)
       update_via_turbo_stream(
         component: Backlogs::SprintFormComponent.new(
           sprint:,
+          project: @project,
           base_errors:
         ),
         status: :bad_request
@@ -169,15 +170,23 @@ def load_sprint_and_project
     end
 
     def sprint_params
-      params.permit(sprint: %i[name start_date finish_date])
+      params.permit(sprint: %i[name start_date finish_date goal])
     end
 
     def edit_sprint_params
-      params.permit(sprint: %i[id name start_date finish_date])
+      params.permit(sprint: %i[id name start_date finish_date goal])
+    end
+
+    def goal_param
+      sprint_params.dig(:sprint, :goal)
+    end
+
+    def sprint_update_params
+      sprint_params[:sprint].except(:goal)
     end
 
     def converted_sprint_params
-      converted_params = sprint_params[:sprint].to_h
+      converted_params = sprint_params[:sprint].to_h.except(:goal)
       converted_params[:project] = @project
 
       converted_params

modules/backlogs/app/forms/backlogs/sprints/dates_form.rb

@@ -31,8 +31,15 @@
 module Backlogs
   module Sprints
     class DatesForm < ApplicationForm
+      attr_reader :disabled
+
       delegate :active?, to: :model
 
+      def initialize(disabled: false)
+        @disabled = disabled
+        super()
+      end
+
       form do |f|
         f.group(layout: :horizontal) do |dates|
           dates.text_field(
@@ -41,6 +48,7 @@ class DatesForm < ApplicationForm
             label: attribute_name(:start_date),
             placeholder: attribute_name(:start_date),
             required: active?,
+            disabled:,
             input_width: :small,
             data: {
               action: "change->refresh-on-form-changes#triggerTurboStream"
@@ -52,6 +60,7 @@ class DatesForm < ApplicationForm
             label: attribute_name(:finish_date),
             placeholder: attribute_name(:finish_date),
             required: active?,
+            disabled:,
             input_width: :small,
             data: {
               action: "change->refresh-on-form-changes#triggerTurboStream"
@@ -62,6 +71,7 @@ class DatesForm < ApplicationForm
             label: attribute_name(:duration),
             input_width: :xsmall,
             readonly: true,
+            disabled:,
             value: display_duration
           )
         end

modules/backlogs/app/forms/backlogs/sprints/details_form.rb

@@ -31,6 +31,13 @@
 module Backlogs
   module Sprints
     class DetailsForm < ApplicationForm
+      attr_reader :disabled
+
+      def initialize(disabled: false)
+        @disabled = disabled
+        super()
+      end
+
       form do |f|
         f.hidden(name: :id)
 
@@ -39,16 +46,9 @@ class DetailsForm < ApplicationForm
           name: :name,
           required: true,
           autofocus: true,
+          disabled:,
           w: :full
         )
-
-        # f.text_area(
-        #   label: attribute_name(:goal),
-        #   name: :goal,
-        #   required: false,
-        #   w: :full,
-        #   rows: 3
-        # )
       end
     end
   end

modules/backlogs/app/services/sprints/create_service.rb

@@ -32,4 +32,26 @@ class Sprints::CreateService < BaseServices::Create
   def instance_class
     Sprint
   end
+
+  protected
+
+  def set_attributes_params(params)
+    super.except(:goal, :goal_project)
+  end
+
+  def after_perform(service_call)
+    super.tap do
+      persist_goal(service_call) if service_call.success?
+    end
+  end
+
+  private
+
+  def persist_goal(service_call)
+    goal_text = params[:goal]
+    return if goal_text.nil?
+
+    sprint = service_call.result
+    SprintGoal.create!(sprint:, project: sprint.project, goal: goal_text) if goal_text.present?
+  end
 end

modules/backlogs/app/services/sprints/update_service.rb

@@ -32,4 +32,36 @@ class Sprints::UpdateService < BaseServices::Update
   def instance_class
     Sprint
   end
+
+  protected
+
+  def set_attributes_params(params)
+    super.except(:goal, :goal_project)
+  end
+
+  def after_perform(service_call)
+    super.tap do
+      persist_goal(service_call) if service_call.success?
+    end
+  end
+
+  private
+
+  def persist_goal(service_call)
+    goal_text = params[:goal]
+    return if goal_text.nil?
+
+    sprint = service_call.result
+    project = params[:goal_project] || sprint.project
+
+    return unless user.allowed_in_project?(:create_sprints, project)
+
+    sprint_goal = SprintGoal.find_or_initialize_by(sprint:, project:)
+
+    if goal_text.present?
+      sprint_goal.update!(goal: goal_text)
+    elsif sprint_goal.persisted?
+      sprint_goal.destroy!
+    end
+  end
 end

modules/backlogs/config/locales/en.yml

@@ -96,6 +96,12 @@ en:
       sprint: "Sprint"
 
   backlogs:
+    sprint_form:
+      shared_sprint_info_banner: "This is a shared sprint. Modifications will be reflected in all projects using it."
+      shared_sprint_warning_banner: "This is a shared sprint. You do not have the necessary permissions to edit it."
+      goal_for_this_project_suffix: "(for this project)"
+      goal_caption: "The sprint goal is unique to this project and is not shared with other projects also using this sprint."
+
     caption_sprints_default_fold_state: "Sprints will not be expanded by default when viewing the 'Backlog and sprints' page. Each one has to be manually expanded."
     definition_of_done: "Definition of Done"
     definition_of_done_caption: "Work packages with these statuses are treated as completed in backlog views and reporting."