[Dream-719] Allow configuration for WP types to show project attributes (#23778)

* Add a migration to create the join table between custom field and type

* Add contract and services

* Create row, section and index components

* Add a new tab to the work package type page

* Add specs

* Fix yamllint errors

* Remove invalid demo project submodule reference

* Specs for contracts

* Use filter--filter-list controller and show error when there is an unsuccessful action and  use params.permit(:value)[:value]

* Raise argumentError in perform_bulk_edit and make create_mapping and destroy_mapping private

* Create a helper for project attribute specs

* Use BorderBoxListComponent for type project attributes

* Use the grouped project custom field ordering helper

* Add a tab for project attributes within the WP view

* Don't use the overview components but specific ones for the new tab and add some specs

* Only show the ProjectAttributes tab when there are project attributes visible to the user

* Remove inspect from unsupported project attribute bulk update action messages

* Only show project attributes configured for this Wp type

* * Allow editing project attributes when the edit permission is present without "edit_project" permission
* Do some code optimizations

* Add descriptional text similiar to how it was done for the pdf export tab

---------

Co-authored-by: Henriette Darge <h.darge@openproject.com>

Author: bsatarnejad

app/components/work_package_types/project_attributes/index_component.html.erb

@@ -0,0 +1,38 @@
+<%=
+  component_wrapper(data: wrapper_data_attributes) do
+    flex_layout do |flex|
+      flex.with_row do
+        render(Primer::OpenProject::SubHeader.new) do |subheader|
+          subheader.with_filter_input(
+            name: "border-box-filter",
+            label: t("types.edit.project_attributes.filter"),
+            visually_hide_label: true,
+            placeholder: t("types.edit.project_attributes.filter"),
+            leading_visual: {
+              icon: :search,
+              size: :small
+            },
+            show_clear_button: true,
+            clear_button_id: clear_button_id,
+            data: {
+              action: "input->filter--filter-list#filterLists",
+              "filter--filter-list-target": "filter"
+            }
+          )
+        end
+      end
+
+      @project_custom_field_sections.each do |project_custom_field_section, project_custom_fields|
+        flex.with_row do
+          render(
+            WorkPackageTypes::ProjectAttributes::SectionComponent.new(
+              type: @type,
+              project_custom_field_section:,
+              project_custom_fields:
+            )
+          )
+        end
+      end
+    end
+  end
+%>

app/components/work_package_types/project_attributes/index_component.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+module WorkPackageTypes
+  module ProjectAttributes
+    class IndexComponent < ApplicationComponent
+      include ApplicationHelper
+      include OpPrimer::ComponentHelpers
+      include OpTurbo::Streamable
+
+      def initialize(type:, project_custom_field_sections:)
+        super
+
+        @type = type
+        @project_custom_field_sections = project_custom_field_sections
+      end
+
+      private
+
+      def wrapper_data_attributes
+        {
+          controller: "filter--filter-list",
+          "filter--filter-list-clear-button-id-value": clear_button_id
+        }
+      end
+
+      def clear_button_id
+        "project-attributes-filter-clear-button"
+      end
+    end
+  end
+end

app/components/work_package_types/project_attributes/row_component.html.erb

@@ -0,0 +1,44 @@
+<%=
+  component_wrapper do
+    flex_layout(
+      align_items: :center, justify_content: :space_between, classes: "op-project-custom-field", data: {
+        test_selector: "type-project-attribute-#{@project_custom_field.id}"
+      }
+    ) do |custom_field_container|
+      custom_field_container.with_column(flex_layout: true) do |title_container|
+        title_container.with_column(pt: 1, mr: 2) do
+          render(Primer::Beta::Text.new(classes: "filter-target-visible-text")) do
+            @project_custom_field.name
+          end
+        end
+        title_container.with_column(pt: 1, mr: 2, data: { test_selector: "custom-field-type" }) do
+          render(Primer::Beta::Text.new(font_size: :small, color: :subtle)) do
+            helpers.label_for_custom_field_format(@project_custom_field.field_format)
+          end
+        end
+        if @project_custom_field.required?
+          title_container.with_column(pt: 1) do
+            render(Primer::Beta::Label.new(scheme: :attention, size: :medium)) do
+              ProjectCustomField.human_attribute_name(:required)
+            end
+          end
+        end
+      end
+
+      custom_field_container.with_column(py: 1, mr: 2) do
+        render(
+          Primer::Alpha::ToggleSwitch.new(
+            src: toggle_path,
+            csrf_token: form_authenticity_token,
+            data: toggle_data_attributes,
+            checked: active_for_type?,
+            enabled: true,
+            size: :small,
+            status_label_position: :start,
+            classes: "op-primer-adjustments__toggle-switch--hidden-loading-indicator"
+          )
+        )
+      end
+    end
+  end
+%>

app/components/work_package_types/project_attributes/row_component.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+module WorkPackageTypes
+  module ProjectAttributes
+    class RowComponent < ApplicationComponent
+      include ApplicationHelper
+      include OpPrimer::ComponentHelpers
+      include OpTurbo::Streamable
+
+      def initialize(type:, project_custom_field:)
+        super
+
+        @type = type
+        @project_custom_field = project_custom_field
+        @project_custom_field_type_mappings = type.project_custom_field_type_mappings
+      end
+
+      private
+
+      def wrapper_uniq_by
+        @project_custom_field.id
+      end
+
+      def active_for_type?
+        @project_custom_field_type_mappings.any? do |mapping|
+          mapping.custom_field_id == @project_custom_field.id
+        end
+      end
+
+      def toggle_path
+        toggle_type_project_attributes_path(
+          @type,
+          project_custom_field_type_mapping: {
+            type_id: @type.id,
+            custom_field_id: @project_custom_field.id
+          }
+        )
+      end
+
+      def toggle_data_attributes
+        {
+          "turbo-method": :post,
+          "turbo-stream": true,
+          test_selector: "toggle-type-project-attribute-#{@project_custom_field.id}"
+        }
+      end
+    end
+  end
+end

app/components/work_package_types/project_attributes/section_component.html.erb

@@ -0,0 +1,70 @@
+<%= component_wrapper do %>
+  <%=
+    render(
+      OpenProject::Common::BorderBoxListComponent.new(
+        container: "type-project-attribute-section-#{@project_custom_field_section.id}",
+        mb: 3,
+        classes: "op-project-custom-field-section",
+        test_selector: "type-project-attribute-section-#{@project_custom_field_section.id}"
+      )
+    ) do |list|
+      list.with_header(
+        title: @project_custom_field_section.name,
+        title_arguments: { font_weight: :bold }
+      ) do |header|
+        header.with_action_button(
+          tag: :a,
+          href: enable_all_path,
+          scheme: :invisible,
+          font_weight: :bold,
+          color: :subtle,
+          "aria-label": t("types.edit.project_attributes.actions.label_enable_all"),
+          data: {
+            "turbo-method": :put,
+            "turbo-stream": true,
+            test_selector: "enable-all-type-project-attributes-#{@project_custom_field_section.id}"
+          }
+        ) do |button|
+          button.with_leading_visual_icon(icon: "check-circle", color: :subtle)
+          t("types.edit.project_attributes.actions.label_enable_all")
+        end
+
+        header.with_action_button(
+          tag: :a,
+          href: disable_all_path,
+          scheme: :invisible,
+          font_weight: :bold,
+          color: :subtle,
+          "aria-label": t("types.edit.project_attributes.actions.label_disable_all"),
+          data: {
+            "turbo-method": :put,
+            "turbo-stream": true,
+            test_selector: "disable-all-type-project-attributes-#{@project_custom_field_section.id}"
+          }
+        ) do |button|
+          button.with_leading_visual_icon(icon: "x-circle", color: :subtle)
+          t("types.edit.project_attributes.actions.label_disable_all")
+        end
+      end
+
+      if @project_custom_fields.empty?
+        list.with_item do
+          render(Primer::Beta::Text.new(color: :subtle)) do
+            t("settings.project_attributes.label_no_project_custom_fields")
+          end
+        end
+      else
+        @project_custom_fields.each do |project_custom_field|
+          list.with_item(data: { "filter--filter-list-target": "searchItem" }) do
+            render(
+              WorkPackageTypes::ProjectAttributes::RowComponent.new(
+                type: @type,
+                project_custom_field:
+              )
+            )
+          end
+        end
+      end
+    end
+  %>
+<% end %>

app/components/work_package_types/project_attributes/section_component.rb

@@ -0,0 +1,56 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+module WorkPackageTypes
+  module ProjectAttributes
+    class SectionComponent < ApplicationComponent
+      include ApplicationHelper
+      include OpPrimer::ComponentHelpers
+      include OpTurbo::Streamable
+
+      def initialize(type:, project_custom_field_section:, project_custom_fields:)
+        super
+
+        @type = type
+        @project_custom_field_section = project_custom_field_section
+        @project_custom_fields = project_custom_fields
+      end
+
+      private
+
+      def enable_all_path
+        enable_all_of_section_type_project_attributes_path(
+          @type,
+          project_custom_field_type_mapping: bulk_action_params
+        )
+      end
+
+      def disable_all_path
+        disable_all_of_section_type_project_attributes_path(
+          @type,
+          project_custom_field_type_mapping: bulk_action_params
+        )
+      end
+
+      def bulk_action_params
+        {
+          type_id: @type.id,
+          custom_field_section_id: @project_custom_field_section.id
+        }
+      end
+
+      def wrapper_uniq_by
+        @project_custom_field_section.id
+      end
+    end
+  end
+end

app/components/work_packages/project_attributes_tab_component.html.erb

@@ -0,0 +1,19 @@
+<turbo-frame id="work-package-project-attributes-tab-content">
+  <%=
+    component_wrapper do
+      if project_custom_fields_grouped_by_section.any?
+        render(Primer::OpenProject::SidePanel.new) do |panel|
+          project_custom_fields_grouped_by_section.each do |project_custom_field_section, project_custom_fields|
+            panel.with_section(
+              WorkPackages::ProjectCustomFields::SectionComponent.new(
+                project: @project,
+                project_custom_field_section:,
+                project_custom_fields:
+              )
+            )
+          end
+        end
+      end
+    end
+  %>
+</turbo-frame>

app/components/work_packages/project_attributes_tab_component.rb

@@ -0,0 +1,54 @@
+# frozen_string_literal: true
+
+#-- copyright
+# OpenProject is an open source project management software.
+# Copyright (C) the OpenProject GmbH
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License version 3.
+#
+# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
+# Copyright (C) 2006-2013 Jean-Philippe Lang
+# Copyright (C) 2010-2013 the ChiliProject Team
+#
+# This program is free software; you can redistribute it and/or
+# modify it under the terms of the GNU General Public License
+# as published by the Free Software Foundation; either version 2
+# of the License, or (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+#
+# See COPYRIGHT and LICENSE files for more details.
+#++
+
+class WorkPackages::ProjectAttributesTabComponent < ApplicationComponent
+  include OpPrimer::ComponentHelpers
+  include OpTurbo::Streamable
+
+  def initialize(work_package:)
+    super
+
+    @work_package = work_package
+    @project = work_package.project
+  end
+
+  def render?
+    project_custom_fields_grouped_by_section.any?
+  end
+
+  private
+
+  def project_custom_fields_grouped_by_section
+    @project_custom_fields_grouped_by_section ||=
+      ProjectCustomFieldSection.grouped_in_order(
+        @project.available_custom_fields_for_type(@work_package.type_id)
+      )
+  end
+end