From dde1cb37da5cc01a260c4c7a97e2f1ac7693a5d7 Mon Sep 17 00:00:00 2001
From: Christophe Bliard <c.bliard@openproject.com>
Date: Thu, 29 Aug 2024 10:57:28 +0200
Subject: [PATCH 01/10] Rename 'Work packages settings' page as 'General'

---
 app/components/types/edit_page_header_component.rb        | 2 +-
 app/components/workflows/page_header_component.rb         | 2 +-
 .../admin/settings/work_packages_settings_controller.rb   | 2 +-
 .../admin/settings/work_packages_settings/show.html.erb   | 8 ++++----
 app/views/custom_actions/edit.html.erb                    | 2 +-
 app/views/custom_actions/index.html.erb                   | 2 +-
 app/views/custom_actions/new.html.erb                     | 2 +-
 app/views/statuses/edit.html.erb                          | 2 +-
 app/views/statuses/index.html.erb                         | 2 +-
 app/views/statuses/new.html.erb                           | 2 +-
 app/views/types/index.html.erb                            | 2 +-
 app/views/types/new.html.erb                              | 2 +-
 config/initializers/menus.rb                              | 4 ++--
 config/locales/en.yml                                     | 1 -
 config/routes.rb                                          | 2 +-
 15 files changed, 18 insertions(+), 19 deletions(-)

diff --git a/app/components/types/edit_page_header_component.rb b/app/components/types/edit_page_header_component.rb
index 950c93203bfd..ad254afd81b1 100644
--- a/app/components/types/edit_page_header_component.rb
+++ b/app/components/types/edit_page_header_component.rb
@@ -42,7 +42,7 @@ def initialize(type:, tabs: nil)
 
     def breadcrumb_items
       [{ href: admin_index_path, text: t("label_administration") },
-       { href: admin_settings_work_package_tracking_path, text: t(:label_work_package_plural) },
+       { href: admin_settings_work_packages_general_path, text: t(:label_work_package_plural) },
        { href: types_path, text: t(:label_type_plural) },
        @type.name]
     end
diff --git a/app/components/workflows/page_header_component.rb b/app/components/workflows/page_header_component.rb
index 7d93e1d92c3c..0df058b70a17 100644
--- a/app/components/workflows/page_header_component.rb
+++ b/app/components/workflows/page_header_component.rb
@@ -40,7 +40,7 @@ def initialize(state:)
 
     def breadcrumb_items
       base_items = [{ href: admin_index_path, text: t("label_administration") },
-                    { href: admin_settings_work_package_tracking_path, text: t(:label_work_package_plural) },
+                    { href: admin_settings_work_packages_general_path, text: t(:label_work_package_plural) },
                     title]
 
       if @state == :edit
diff --git a/app/controllers/admin/settings/work_packages_settings_controller.rb b/app/controllers/admin/settings/work_packages_settings_controller.rb
index d2f1f369f00f..20e9004c6d93 100644
--- a/app/controllers/admin/settings/work_packages_settings_controller.rb
+++ b/app/controllers/admin/settings/work_packages_settings_controller.rb
@@ -29,7 +29,7 @@
 module Admin::Settings
   class WorkPackagesSettingsController < ::Admin::SettingsController
     current_menu_item :show do
-      :work_packages_setting
+      :work_packages_settings_general
     end
   end
 end
diff --git a/app/views/admin/settings/work_packages_settings/show.html.erb b/app/views/admin/settings/work_packages_settings/show.html.erb
index 24865fffc3c2..06610ce17128 100644
--- a/app/views/admin/settings/work_packages_settings/show.html.erb
+++ b/app/views/admin/settings/work_packages_settings/show.html.erb
@@ -27,14 +27,14 @@ See COPYRIGHT and LICENSE files for more details.
 
 ++#%>
 
-<% html_title t(:label_administration), t(:label_work_packages_settings) -%>
+<% html_title t(:label_administration), t(:label_work_package_plural), t(:label_general) -%>
 
 <%=
   render Primer::OpenProject::PageHeader.new do |header|
-    header.with_title { t(:label_work_packages_settings) }
+    header.with_title { t(:label_general) }
     header.with_breadcrumbs([{ href: admin_index_path, text: t("label_administration") },
-                             { href: admin_settings_work_package_tracking_path, text: t(:label_work_package_plural) },
-                             t(:label_work_packages_settings)])
+                             { href: admin_settings_work_packages_general_path, text: t(:label_work_package_plural) },
+                             t(:label_general)])
   end
 %>
 
diff --git a/app/views/custom_actions/edit.html.erb b/app/views/custom_actions/edit.html.erb
index 6c6a563ca8ca..9005be612aaf 100644
--- a/app/views/custom_actions/edit.html.erb
+++ b/app/views/custom_actions/edit.html.erb
@@ -33,7 +33,7 @@ See COPYRIGHT and LICENSE files for more details.
   render Primer::OpenProject::PageHeader.new do |header|
     header.with_title { @custom_action.name }
     header.with_breadcrumbs([{ href: admin_index_path, text: t("label_administration") },
-                             { href: admin_settings_work_package_tracking_path, text: t(:label_work_package_plural) },
+                             { href: admin_settings_work_packages_general_path, text: t(:label_work_package_plural) },
                              { href: custom_actions_path, text: t("custom_actions.plural") },
                              @custom_action.name ])
   end
diff --git a/app/views/custom_actions/index.html.erb b/app/views/custom_actions/index.html.erb
index 7b56c168457a..f391825bb692 100644
--- a/app/views/custom_actions/index.html.erb
+++ b/app/views/custom_actions/index.html.erb
@@ -4,7 +4,7 @@
   render Primer::OpenProject::PageHeader.new do |header|
     header.with_title { t("custom_actions.plural") }
     header.with_breadcrumbs([{ href: admin_index_path, text: t("label_administration") },
-                             { href: admin_settings_work_package_tracking_path, text: t(:label_work_package_plural) },
+                             { href: admin_settings_work_packages_general_path, text: t(:label_work_package_plural) },
                              t("custom_actions.plural") ])
   end
 %>
diff --git a/app/views/custom_actions/new.html.erb b/app/views/custom_actions/new.html.erb
index f124a55d65bb..50b2cebfa625 100644
--- a/app/views/custom_actions/new.html.erb
+++ b/app/views/custom_actions/new.html.erb
@@ -33,7 +33,7 @@ See COPYRIGHT and LICENSE files for more details.
   render Primer::OpenProject::PageHeader.new do |header|
     header.with_title { t("custom_actions.new") }
     header.with_breadcrumbs([{ href: admin_index_path, text: t("label_administration") },
-                             { href: admin_settings_work_package_tracking_path, text: t(:label_work_package_plural) },
+                             { href: admin_settings_work_packages_general_path, text: t(:label_work_package_plural) },
                              { href: custom_actions_path, text: t("custom_actions.plural") },
                              t("custom_actions.new") ])
   end
diff --git a/app/views/statuses/edit.html.erb b/app/views/statuses/edit.html.erb
index d955e4ce3c2c..428fe61dd969 100644
--- a/app/views/statuses/edit.html.erb
+++ b/app/views/statuses/edit.html.erb
@@ -33,7 +33,7 @@ See COPYRIGHT and LICENSE files for more details.
   render Primer::OpenProject::PageHeader.new do |header|
     header.with_title { @status.name }
     header.with_breadcrumbs([{ href: admin_index_path, text: t("label_administration") },
-                             { href: admin_settings_work_package_tracking_path, text: t(:label_work_package_plural) },
+                             { href: admin_settings_work_packages_general_path, text: t(:label_work_package_plural) },
                              { href: statuses_path, text: t(:label_status) },
                              @status.name])
   end
diff --git a/app/views/statuses/index.html.erb b/app/views/statuses/index.html.erb
index 5bbbfe24fc45..cf0dbfb93692 100644
--- a/app/views/statuses/index.html.erb
+++ b/app/views/statuses/index.html.erb
@@ -33,7 +33,7 @@ See COPYRIGHT and LICENSE files for more details.
   render Primer::OpenProject::PageHeader.new do |header|
     header.with_title { I18n.t(:label_status) }
     header.with_breadcrumbs([{ href: admin_index_path, text: t("label_administration") },
-                             { href: admin_settings_work_package_tracking_path, text: t(:label_work_package_plural) },
+                             { href: admin_settings_work_packages_general_path, text: t(:label_work_package_plural) },
                              I18n.t(:label_status)])
   end
 %>
diff --git a/app/views/statuses/new.html.erb b/app/views/statuses/new.html.erb
index a3537b90d16e..8b5b660713a6 100644
--- a/app/views/statuses/new.html.erb
+++ b/app/views/statuses/new.html.erb
@@ -33,7 +33,7 @@ See COPYRIGHT and LICENSE files for more details.
   render Primer::OpenProject::PageHeader.new do |header|
     header.with_title { t(:label_work_package_status_new) }
     header.with_breadcrumbs([{ href: admin_index_path, text: t("label_administration") },
-                             { href: admin_settings_work_package_tracking_path, text: t(:label_work_package_plural) },
+                             { href: admin_settings_work_packages_general_path, text: t(:label_work_package_plural) },
                              { href: statuses_path, text: t(:label_status) },
                              t(:label_work_package_status_new)])
   end
diff --git a/app/views/types/index.html.erb b/app/views/types/index.html.erb
index 7794772696fe..1b8856b626e1 100644
--- a/app/views/types/index.html.erb
+++ b/app/views/types/index.html.erb
@@ -33,7 +33,7 @@ See COPYRIGHT and LICENSE files for more details.
   render Primer::OpenProject::PageHeader.new do |header|
     header.with_title { t(:label_type_plural) }
     header.with_breadcrumbs([{ href: admin_index_path, text: t("label_administration") },
-                             { href: admin_settings_work_package_tracking_path, text: t(:label_work_package_plural) },
+                             { href: admin_settings_work_packages_general_path, text: t(:label_work_package_plural) },
                              t(:label_type_plural)])
   end
 %>
diff --git a/app/views/types/new.html.erb b/app/views/types/new.html.erb
index 44eee4a52a3a..60cc30a16a0e 100644
--- a/app/views/types/new.html.erb
+++ b/app/views/types/new.html.erb
@@ -33,7 +33,7 @@ See COPYRIGHT and LICENSE files for more details.
   render Primer::OpenProject::PageHeader.new do |header|
     header.with_title { t(:label_type_new) }
     header.with_breadcrumbs([{ href: admin_index_path, text: t("label_administration") },
-                             { href: admin_settings_work_package_tracking_path, text: t(:label_work_package_plural) },
+                             { href: admin_settings_work_packages_general_path, text: t(:label_work_package_plural) },
                              { href: types_path, text: t(:label_type_plural) },
                              t(:label_type_new)])
   end
diff --git a/config/initializers/menus.rb b/config/initializers/menus.rb
index 8800c3d6a770..e07c9ca255d1 100644
--- a/config/initializers/menus.rb
+++ b/config/initializers/menus.rb
@@ -305,10 +305,10 @@
             caption: :label_work_package_plural,
             icon: "op-view-list"
 
-  menu.push :work_packages_setting,
+  menu.push :work_packages_settings_general,
             { controller: "/admin/settings/work_packages_settings", action: :show },
             if: Proc.new { User.current.admin? },
-            caption: :label_work_packages_settings,
+            caption: :label_general,
             parent: :admin_work_packages
 
   menu.push :types,
diff --git a/config/locales/en.yml b/config/locales/en.yml
index d647c65ab1db..a6fdc41e63b3 100644
--- a/config/locales/en.yml
+++ b/config/locales/en.yml
@@ -2598,7 +2598,6 @@ en:
   label_work_package_new: "New work package"
   label_work_package_edit: "Edit work package %{name}"
   label_work_package_plural: "Work packages"
-  label_work_packages_settings: "Work packages settings"
   label_work_package_status: "Work package status"
   label_work_package_status_new: "New status"
   label_work_package_status_plural: "Work package statuses"
diff --git a/config/routes.rb b/config/routes.rb
index 599deee6f166..0f580ac17c59 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -490,7 +490,7 @@
       resource :api, controller: "/admin/settings/api_settings", only: %i[show update]
       # It is important to have this named something else than "work_packages".
       # Otherwise the angular ui-router will also recognize that as a WorkPackage page and apply according classes.
-      resource :work_package_tracking, controller: "/admin/settings/work_packages_settings", only: %i[show update]
+      resource :work_packages_general, controller: "/admin/settings/work_packages_settings", only: %i[show update]
       resource :projects, controller: "/admin/settings/projects_settings", only: %i[show update]
       resource :new_project, controller: "/admin/settings/new_project_settings", only: %i[show update]
       resources :project_custom_fields, controller: "/admin/settings/project_custom_fields" do

From aea93c6835eb17f3260310cf596f064fb1f6dcb3 Mon Sep 17 00:00:00 2001
From: Christophe Bliard <c.bliard@openproject.com>
Date: Thu, 29 Aug 2024 11:20:26 +0200
Subject: [PATCH 02/10] refactor: Rename WorkPackageSettingsController to
 WorkPackageGeneralController

---
 ...gs_controller.rb => work_packages_general_controller.rb} | 4 ++--
 .../_enterprise_feature_hint.html.erb                       | 0
 .../show.html.erb                                           | 0
 config/initializers/menus.rb                                | 6 +++---
 config/routes.rb                                            | 2 +-
 ...ler_spec.rb => work_packages_general_controller_spec.rb} | 4 ++--
 6 files changed, 8 insertions(+), 8 deletions(-)
 rename app/controllers/admin/settings/{work_packages_settings_controller.rb => work_packages_general_controller.rb} (92%)
 rename app/views/admin/settings/{work_packages_settings => work_packages_general}/_enterprise_feature_hint.html.erb (100%)
 rename app/views/admin/settings/{work_packages_settings => work_packages_general}/show.html.erb (100%)
 rename spec/controllers/admin/settings/{work_packages_settings_controller_spec.rb => work_packages_general_controller_spec.rb} (96%)

diff --git a/app/controllers/admin/settings/work_packages_settings_controller.rb b/app/controllers/admin/settings/work_packages_general_controller.rb
similarity index 92%
rename from app/controllers/admin/settings/work_packages_settings_controller.rb
rename to app/controllers/admin/settings/work_packages_general_controller.rb
index 20e9004c6d93..82164cb79875 100644
--- a/app/controllers/admin/settings/work_packages_settings_controller.rb
+++ b/app/controllers/admin/settings/work_packages_general_controller.rb
@@ -27,9 +27,9 @@
 #++
 
 module Admin::Settings
-  class WorkPackagesSettingsController < ::Admin::SettingsController
+  class WorkPackagesGeneralController < ::Admin::SettingsController
     current_menu_item :show do
-      :work_packages_settings_general
+      :work_packages_general
     end
   end
 end
diff --git a/app/views/admin/settings/work_packages_settings/_enterprise_feature_hint.html.erb b/app/views/admin/settings/work_packages_general/_enterprise_feature_hint.html.erb
similarity index 100%
rename from app/views/admin/settings/work_packages_settings/_enterprise_feature_hint.html.erb
rename to app/views/admin/settings/work_packages_general/_enterprise_feature_hint.html.erb
diff --git a/app/views/admin/settings/work_packages_settings/show.html.erb b/app/views/admin/settings/work_packages_general/show.html.erb
similarity index 100%
rename from app/views/admin/settings/work_packages_settings/show.html.erb
rename to app/views/admin/settings/work_packages_general/show.html.erb
diff --git a/config/initializers/menus.rb b/config/initializers/menus.rb
index e07c9ca255d1..8f6f602152cb 100644
--- a/config/initializers/menus.rb
+++ b/config/initializers/menus.rb
@@ -300,13 +300,13 @@
             parent: :users_and_permissions
 
   menu.push :admin_work_packages,
-            { controller: "/admin/settings/work_packages_settings", action: :show },
+            { controller: "/admin/settings/work_packages_general", action: :show },
             if: Proc.new { User.current.admin? },
             caption: :label_work_package_plural,
             icon: "op-view-list"
 
-  menu.push :work_packages_settings_general,
-            { controller: "/admin/settings/work_packages_settings", action: :show },
+  menu.push :work_packages_general,
+            { controller: "/admin/settings/work_packages_general", action: :show },
             if: Proc.new { User.current.admin? },
             caption: :label_general,
             parent: :admin_work_packages
diff --git a/config/routes.rb b/config/routes.rb
index 0f580ac17c59..010719637780 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -490,7 +490,7 @@
       resource :api, controller: "/admin/settings/api_settings", only: %i[show update]
       # It is important to have this named something else than "work_packages".
       # Otherwise the angular ui-router will also recognize that as a WorkPackage page and apply according classes.
-      resource :work_packages_general, controller: "/admin/settings/work_packages_settings", only: %i[show update]
+      resource :work_packages_general, controller: "/admin/settings/work_packages_general", only: %i[show update]
       resource :projects, controller: "/admin/settings/projects_settings", only: %i[show update]
       resource :new_project, controller: "/admin/settings/new_project_settings", only: %i[show update]
       resources :project_custom_fields, controller: "/admin/settings/project_custom_fields" do
diff --git a/spec/controllers/admin/settings/work_packages_settings_controller_spec.rb b/spec/controllers/admin/settings/work_packages_general_controller_spec.rb
similarity index 96%
rename from spec/controllers/admin/settings/work_packages_settings_controller_spec.rb
rename to spec/controllers/admin/settings/work_packages_general_controller_spec.rb
index 98a0e6067bfc..4f4140fe0255 100644
--- a/spec/controllers/admin/settings/work_packages_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/work_packages_general_controller_spec.rb
@@ -31,12 +31,12 @@
 
 require "spec_helper"
 
-RSpec.describe Admin::Settings::WorkPackagesSettingsController do
+RSpec.describe Admin::Settings::WorkPackagesGeneralController do
   shared_let(:user) { create(:admin) }
 
   current_user { user }
 
-  require_admin_and_render_template("work_packages_settings")
+  require_admin_and_render_template("work_packages_general")
 
   context "when changing progress calculation from work-based to status-based" do
     shared_let(:status) { create(:status, default_done_ratio: 42) }

From 1affbd5f24a62a28350f0d5ade1ae0a3a35dec81 Mon Sep 17 00:00:00 2001
From: Christophe Bliard <c.bliard@openproject.com>
Date: Thu, 29 Aug 2024 16:02:52 +0200
Subject: [PATCH 03/10] Remove unused css class

---
 config/initializers/menus.rb | 3 +--
 1 file changed, 1 insertion(+), 2 deletions(-)

diff --git a/config/initializers/menus.rb b/config/initializers/menus.rb
index 8f6f602152cb..8fbdd3f96f7b 100644
--- a/config/initializers/menus.rb
+++ b/config/initializers/menus.rb
@@ -321,8 +321,7 @@
             { controller: "/statuses" },
             if: Proc.new { User.current.admin? },
             caption: :label_status,
-            parent: :admin_work_packages,
-            html: { class: "statuses" }
+            parent: :admin_work_packages
 
   menu.push :workflows,
             { controller: "/workflows", action: "edit" },

From e4e18cdf6c56372e90346e31c81b26bf52a1eca2 Mon Sep 17 00:00:00 2001
From: Christophe Bliard <c.bliard@openproject.com>
Date: Wed, 4 Sep 2024 14:45:31 +0200
Subject: [PATCH 04/10] refactor: use shared_examples instead of obscure method

I did not understand what `require_admin_and_render_template` was
supposed to do. I thought it was creating some initial user and
rendering the template as a before action, but actually it only adds
some examples.

Using RSpec shared examples makes intent clearer.
---
 .../admin/settings/aggregation_settings_controller_spec.rb  | 6 +++---
 .../admin/settings/api_settings_controller_spec.rb          | 4 ++--
 .../admin/settings/attachments_settings_controller_spec.rb  | 4 ++--
 .../settings/authentication_settings_controller_spec.rb     | 2 +-
 .../admin/settings/date_format_settings_controller_spec.rb  | 2 +-
 .../admin/settings/general_settings_controller_spec.rb      | 4 ++--
 .../admin/settings/icalendar_settings_controller_spec.rb    | 2 +-
 .../settings/incoming_mails_settings_controller_spec.rb     | 4 ++--
 .../admin/settings/languages_settings_controller_spec.rb    | 2 +-
 .../settings/mail_notifications_settings_controller_spec.rb | 4 ++--
 .../admin/settings/repositories_settings_controller_spec.rb | 4 ++--
 .../admin/settings/users_settings_controller_spec.rb        | 4 ++--
 .../admin/settings/work_packages_general_controller_spec.rb | 2 +-
 .../working_days_and_hours_settings_controller_spec.rb      | 2 +-
 spec/support/shared/require_admin.rb                        | 2 +-
 15 files changed, 24 insertions(+), 24 deletions(-)

diff --git a/spec/controllers/admin/settings/aggregation_settings_controller_spec.rb b/spec/controllers/admin/settings/aggregation_settings_controller_spec.rb
index d2a3ba3e6da9..9495179af8a4 100644
--- a/spec/controllers/admin/settings/aggregation_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/aggregation_settings_controller_spec.rb
@@ -31,10 +31,10 @@
 
 require "spec_helper"
 
-RSpec.describe Admin::Settings::AggregationSettingsController do # rubocop:disable RSpec/EmptyExampleGroup
+RSpec.describe Admin::Settings::AggregationSettingsController do
   shared_let(:user) { create(:admin) }
 
-  current_user { user }
+  shared_current_user { user }
 
-  require_admin_and_render_template("aggregation_settings")
+  include_examples "GET #show requires admin permission and renders template", path: "aggregation_settings"
 end
diff --git a/spec/controllers/admin/settings/api_settings_controller_spec.rb b/spec/controllers/admin/settings/api_settings_controller_spec.rb
index 89b3c233114a..ce1c3519f10f 100644
--- a/spec/controllers/admin/settings/api_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/api_settings_controller_spec.rb
@@ -31,10 +31,10 @@
 
 require "spec_helper"
 
-RSpec.describe Admin::Settings::APISettingsController do # rubocop:disable RSpec/EmptyExampleGroup
+RSpec.describe Admin::Settings::APISettingsController do
   shared_let(:user) { create(:admin) }
 
   current_user { user }
 
-  require_admin_and_render_template("api_settings")
+  include_examples "GET #show requires admin permission and renders template", path: "api_settings"
 end
diff --git a/spec/controllers/admin/settings/attachments_settings_controller_spec.rb b/spec/controllers/admin/settings/attachments_settings_controller_spec.rb
index aa9687bba2f6..a1cdf7639e4e 100644
--- a/spec/controllers/admin/settings/attachments_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/attachments_settings_controller_spec.rb
@@ -31,10 +31,10 @@
 
 require "spec_helper"
 
-RSpec.describe Admin::Settings::AttachmentsSettingsController do # rubocop:disable RSpec/EmptyExampleGroup
+RSpec.describe Admin::Settings::AttachmentsSettingsController do
   shared_let(:user) { create(:admin) }
 
   current_user { user }
 
-  require_admin_and_render_template("attachments_settings")
+  include_examples "GET #show requires admin permission and renders template", path: "attachments_settings"
 end
diff --git a/spec/controllers/admin/settings/authentication_settings_controller_spec.rb b/spec/controllers/admin/settings/authentication_settings_controller_spec.rb
index e494d2bd3e67..9c7122c49db5 100644
--- a/spec/controllers/admin/settings/authentication_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/authentication_settings_controller_spec.rb
@@ -33,7 +33,7 @@
 
   current_user { user }
 
-  require_admin_and_render_template("authentication_settings")
+  include_examples "GET #show requires admin permission and renders template", path: "authentication_settings"
 
   describe "PATCH #update" do
     describe "registration_footer" do
diff --git a/spec/controllers/admin/settings/date_format_settings_controller_spec.rb b/spec/controllers/admin/settings/date_format_settings_controller_spec.rb
index 558d194e37e8..85eba47390cd 100644
--- a/spec/controllers/admin/settings/date_format_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/date_format_settings_controller_spec.rb
@@ -35,7 +35,7 @@
   shared_let(:user) { create(:admin) }
   current_user { user }
 
-  require_admin_and_render_template("date_format_settings")
+  include_examples "GET #show requires admin permission and renders template", path: "date_format_settings"
 
   describe "PATCH #update" do
     subject { patch "update", params: }
diff --git a/spec/controllers/admin/settings/general_settings_controller_spec.rb b/spec/controllers/admin/settings/general_settings_controller_spec.rb
index b1021f913f7f..74d2b21927f2 100644
--- a/spec/controllers/admin/settings/general_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/general_settings_controller_spec.rb
@@ -31,10 +31,10 @@
 
 require "spec_helper"
 
-RSpec.describe Admin::Settings::GeneralSettingsController do # rubocop:disable RSpec/EmptyExampleGroup
+RSpec.describe Admin::Settings::GeneralSettingsController do
   shared_let(:user) { create(:admin) }
 
   current_user { user }
 
-  require_admin_and_render_template("general_settings")
+  include_examples "GET #show requires admin permission and renders template", path: "general_settings"
 end
diff --git a/spec/controllers/admin/settings/icalendar_settings_controller_spec.rb b/spec/controllers/admin/settings/icalendar_settings_controller_spec.rb
index e97c865fd8b7..b6638bdc8117 100644
--- a/spec/controllers/admin/settings/icalendar_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/icalendar_settings_controller_spec.rb
@@ -36,7 +36,7 @@
 
   current_user { user }
 
-  require_admin_and_render_template("icalendar_settings")
+  include_examples "GET #show requires admin permission and renders template", path: "icalendar_settings"
 
   describe "PATCH #update" do
     subject { patch "update", params: }
diff --git a/spec/controllers/admin/settings/incoming_mails_settings_controller_spec.rb b/spec/controllers/admin/settings/incoming_mails_settings_controller_spec.rb
index afaa981e60ce..37479f01da36 100644
--- a/spec/controllers/admin/settings/incoming_mails_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/incoming_mails_settings_controller_spec.rb
@@ -31,10 +31,10 @@
 
 require "spec_helper"
 
-RSpec.describe Admin::Settings::IncomingMailsSettingsController do # rubocop:disable RSpec/EmptyExampleGroup
+RSpec.describe Admin::Settings::IncomingMailsSettingsController do
   shared_let(:user) { create(:admin) }
 
   current_user { user }
 
-  require_admin_and_render_template("incoming_mails_settings")
+  include_examples "GET #show requires admin permission and renders template", path: "incoming_mails_settings"
 end
diff --git a/spec/controllers/admin/settings/languages_settings_controller_spec.rb b/spec/controllers/admin/settings/languages_settings_controller_spec.rb
index fbca7cb60217..2de57b1bc435 100644
--- a/spec/controllers/admin/settings/languages_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/languages_settings_controller_spec.rb
@@ -36,7 +36,7 @@
 
   current_user { user }
 
-  require_admin_and_render_template("languages_settings")
+  include_examples "GET #show requires admin permission and renders template", path: "languages_settings"
 
   describe "PATCH #update" do
     subject { patch "update", params: }
diff --git a/spec/controllers/admin/settings/mail_notifications_settings_controller_spec.rb b/spec/controllers/admin/settings/mail_notifications_settings_controller_spec.rb
index 2aee4c85c482..6938a5610691 100644
--- a/spec/controllers/admin/settings/mail_notifications_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/mail_notifications_settings_controller_spec.rb
@@ -31,10 +31,10 @@
 
 require "spec_helper"
 
-RSpec.describe Admin::Settings::MailNotificationsSettingsController do # rubocop:disable RSpec/EmptyExampleGroup
+RSpec.describe Admin::Settings::MailNotificationsSettingsController do
   shared_let(:user) { create(:admin) }
 
   current_user { user }
 
-  require_admin_and_render_template("mail_notifications_settings")
+  include_examples "GET #show requires admin permission and renders template", path: "mail_notifications_settings"
 end
diff --git a/spec/controllers/admin/settings/repositories_settings_controller_spec.rb b/spec/controllers/admin/settings/repositories_settings_controller_spec.rb
index c8ba2ac3f7ff..1b32c9e115be 100644
--- a/spec/controllers/admin/settings/repositories_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/repositories_settings_controller_spec.rb
@@ -31,10 +31,10 @@
 
 require "spec_helper"
 
-RSpec.describe Admin::Settings::RepositoriesSettingsController do # rubocop:disable RSpec/EmptyExampleGroup
+RSpec.describe Admin::Settings::RepositoriesSettingsController do
   shared_let(:user) { create(:admin) }
 
   current_user { user }
 
-  require_admin_and_render_template("repositories_settings")
+  include_examples "GET #show requires admin permission and renders template", path: "repositories_settings"
 end
diff --git a/spec/controllers/admin/settings/users_settings_controller_spec.rb b/spec/controllers/admin/settings/users_settings_controller_spec.rb
index fae872a90daa..d805a05b4de7 100644
--- a/spec/controllers/admin/settings/users_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/users_settings_controller_spec.rb
@@ -31,10 +31,10 @@
 
 require "spec_helper"
 
-RSpec.describe Admin::Settings::UsersSettingsController do # rubocop:disable RSpec/EmptyExampleGroup
+RSpec.describe Admin::Settings::UsersSettingsController do
   shared_let(:user) { create(:admin) }
 
   current_user { user }
 
-  require_admin_and_render_template("users_settings")
+  include_examples "GET #show requires admin permission and renders template", path: "users_settings"
 end
diff --git a/spec/controllers/admin/settings/work_packages_general_controller_spec.rb b/spec/controllers/admin/settings/work_packages_general_controller_spec.rb
index 4f4140fe0255..fb2d97be5dfd 100644
--- a/spec/controllers/admin/settings/work_packages_general_controller_spec.rb
+++ b/spec/controllers/admin/settings/work_packages_general_controller_spec.rb
@@ -36,7 +36,7 @@
 
   current_user { user }
 
-  require_admin_and_render_template("work_packages_general")
+  include_examples "GET #show requires admin permission and renders template", path: "work_packages_general"
 
   context "when changing progress calculation from work-based to status-based" do
     shared_let(:status) { create(:status, default_done_ratio: 42) }
diff --git a/spec/controllers/admin/settings/working_days_and_hours_settings_controller_spec.rb b/spec/controllers/admin/settings/working_days_and_hours_settings_controller_spec.rb
index 99daa77fd285..be85865f0d40 100644
--- a/spec/controllers/admin/settings/working_days_and_hours_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/working_days_and_hours_settings_controller_spec.rb
@@ -33,7 +33,7 @@
 
   current_user { user }
 
-  require_admin_and_render_template("working_days_and_hours_settings")
+  include_examples "GET #show requires admin permission and renders template", path: "working_days_and_hours_settings"
 
   describe "update" do
     let(:working_days) { [*"1".."7"] }
diff --git a/spec/support/shared/require_admin.rb b/spec/support/shared/require_admin.rb
index a115fbc5b6ac..2b71a5ab6f3f 100644
--- a/spec/support/shared/require_admin.rb
+++ b/spec/support/shared/require_admin.rb
@@ -26,7 +26,7 @@
 # See COPYRIGHT and LICENSE files for more details.
 #++
 
-def require_admin_and_render_template(path)
+RSpec.shared_examples "GET #show requires admin permission and renders template" do |path:|
   describe "GET #show" do
     subject { get "show" }
 

From edc1d1843af5bbd09854af51a1264c9653c836d6 Mon Sep 17 00:00:00 2001
From: Christophe Bliard <c.bliard@openproject.com>
Date: Wed, 4 Sep 2024 15:00:27 +0200
Subject: [PATCH 05/10] Move progress tracking fields in dedicated admin page

---
 .../settings/progress_tracking_controller.rb  |  35 ++++++
 .../settings/progress_tracking/show.html.erb  |  71 +++++++++++++
 .../work_packages_general/show.html.erb       |  20 +---
 config/initializers/menus.rb                  |   6 ++
 config/locales/en.yml                         |   1 +
 config/routes.rb                              |   1 +
 ...ler.ts => progress-tracking.controller.ts} |   2 +-
 .../progress_tracking_controller_spec.rb      | 100 ++++++++++++++++++
 .../work_packages_general_controller_spec.rb  |  60 -----------
 9 files changed, 216 insertions(+), 80 deletions(-)
 create mode 100644 app/controllers/admin/settings/progress_tracking_controller.rb
 create mode 100644 app/views/admin/settings/progress_tracking/show.html.erb
 rename frontend/src/stimulus/controllers/dynamic/admin/{work-packages-settings.controller.ts => progress-tracking.controller.ts} (97%)
 create mode 100644 spec/controllers/admin/settings/progress_tracking_controller_spec.rb

diff --git a/app/controllers/admin/settings/progress_tracking_controller.rb b/app/controllers/admin/settings/progress_tracking_controller.rb
new file mode 100644
index 000000000000..e6687d0afd6e
--- /dev/null
+++ b/app/controllers/admin/settings/progress_tracking_controller.rb
@@ -0,0 +1,35 @@
+#-- 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.
+#++
+
+module Admin::Settings
+  class ProgressTrackingController < ::Admin::SettingsController
+    current_menu_item :show do
+      :progress_tracking
+    end
+  end
+end
diff --git a/app/views/admin/settings/progress_tracking/show.html.erb b/app/views/admin/settings/progress_tracking/show.html.erb
new file mode 100644
index 000000000000..45e7dcb48f08
--- /dev/null
+++ b/app/views/admin/settings/progress_tracking/show.html.erb
@@ -0,0 +1,71 @@
+<%#-- 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.
+
+++#%>
+
+<% html_title t(:label_administration), t(:label_work_package_plural), t(:label_progress_tracking) -%>
+
+<%=
+  render Primer::OpenProject::PageHeader.new do |header|
+    header.with_title { t(:label_progress_tracking) }
+    header.with_breadcrumbs([{ href: admin_index_path, text: t("label_administration") },
+                             { href: admin_settings_work_packages_general_path, text: t(:label_work_package_plural) },
+                             t(:label_progress_tracking)])
+  end
+%>
+
+<%= styled_form_tag({ action: :update }, method: :patch) do %>
+  <section class="form--section"
+           data-application-target="dynamic"
+           data-controller="admin--progress-tracking"
+           data-admin--progress-tracking-percent-complete-edition-active-value="<%= OpenProject::FeatureDecisions.percent_complete_edition_active? %>">
+    <div class="form--field">
+      <%= setting_select :work_package_done_ratio,
+                         WorkPackage::DONE_RATIO_OPTIONS.collect { |i| [t("setting_work_package_done_ratio_#{i}"), i] },
+                         container_class: "-middle",
+                         data: { admin__progress_tracking_target: "progressCalculationModeSelect",
+                                 action: "admin--progress-tracking#displayWarning" } %>
+      <div class="form--field-instructions"><%=
+        if OpenProject::FeatureDecisions.percent_complete_edition_active?
+          t("setting_work_package_done_ratio_explanation_html")
+        else
+          # This condition branch to be removed in 15.0 with :percent_complete_edition feature flag removal
+          t("setting_work_package_done_ratio_explanation_pre_14_4_without_percent_complete_edition_html")
+        end
+                                            %></div>
+    </div>
+    <div class="op-toast -warning -with-bottom-spacing"
+         hidden
+         data-admin--progress-tracking-target="warningToast">
+      <div class="op-toast--content">
+        <p data-admin--progress-tracking-target="warningText"></p>
+      </div>
+    </div>
+  </section>
+
+  <%= styled_button_tag t(:button_save), class: "-primary -with-icon icon-checkmark" %>
+<% end %>
diff --git a/app/views/admin/settings/work_packages_general/show.html.erb b/app/views/admin/settings/work_packages_general/show.html.erb
index 06610ce17128..b0c7d3445a65 100644
--- a/app/views/admin/settings/work_packages_general/show.html.erb
+++ b/app/views/admin/settings/work_packages_general/show.html.erb
@@ -39,28 +39,10 @@ See COPYRIGHT and LICENSE files for more details.
 %>
 
 <%= styled_form_tag({ action: :update }, method: :patch) do %>
-  <section class="form--section"
-           data-application-target="dynamic"
-           data-controller="admin--work-packages-settings"
-           data-admin--work-packages-settings-percent-complete-edition-active-value="<%= OpenProject::FeatureDecisions.percent_complete_edition_active? %>">
+  <section class="form--section">
     <div class="form--field"><%= setting_check_box :cross_project_work_package_relations %></div>
     <div class="form--field"><%= setting_check_box :display_subprojects_work_packages %></div>
     <div class="form--field"><%= setting_check_box :work_package_startdate_is_adddate %></div>
-    <div class="form--field">
-      <%= setting_select :work_package_done_ratio,
-                         WorkPackage::DONE_RATIO_OPTIONS.collect { |i| [t("setting_work_package_done_ratio_#{i}"), i] },
-                         container_class: "-middle",
-                         data: { admin__work_packages_settings_target: "progressCalculationModeSelect",
-                                 action: "change->admin--work-packages-settings#displayWarning" } %>
-      <div class="form--field-instructions"><%=
-        if OpenProject::FeatureDecisions.percent_complete_edition_active?
-          t("setting_work_package_done_ratio_explanation_html")
-        else
-          # This condition branch to be removed in 15.0 with :percent_complete_edition feature flag removal
-          t("setting_work_package_done_ratio_explanation_pre_14_4_without_percent_complete_edition_html")
-        end
-                                            %></div>
-    </div>
     <div class="op-toast -warning -with-bottom-spacing"
          hidden
          data-admin--work-packages-settings-target="warningToast">
diff --git a/config/initializers/menus.rb b/config/initializers/menus.rb
index 8fbdd3f96f7b..b8488ff778cb 100644
--- a/config/initializers/menus.rb
+++ b/config/initializers/menus.rb
@@ -323,6 +323,12 @@
             caption: :label_status,
             parent: :admin_work_packages
 
+  menu.push :progress_tracking,
+            { controller: "/admin/settings/progress_tracking", action: :show },
+            if: Proc.new { User.current.admin? },
+            caption: :label_progress_tracking,
+            parent: :admin_work_packages
+
   menu.push :workflows,
             { controller: "/workflows", action: "edit" },
             if: Proc.new { User.current.admin? },
diff --git a/config/locales/en.yml b/config/locales/en.yml
index a6fdc41e63b3..b37a56f6a95f 100644
--- a/config/locales/en.yml
+++ b/config/locales/en.yml
@@ -2415,6 +2415,7 @@ en:
   label_product_version: "Product version"
   label_profile: "Profile"
   label_percent_complete: "% Complete"
+  label_progress_tracking: "Progress tracking"
   label_project: "Project"
   label_project_activity: "Project activity"
   label_project_attribute_plural: "Project attributes"
diff --git a/config/routes.rb b/config/routes.rb
index 010719637780..cacfe5afe83f 100644
--- a/config/routes.rb
+++ b/config/routes.rb
@@ -491,6 +491,7 @@
       # It is important to have this named something else than "work_packages".
       # Otherwise the angular ui-router will also recognize that as a WorkPackage page and apply according classes.
       resource :work_packages_general, controller: "/admin/settings/work_packages_general", only: %i[show update]
+      resource :progress_tracking, controller: "/admin/settings/progress_tracking", only: %i[show update]
       resource :projects, controller: "/admin/settings/projects_settings", only: %i[show update]
       resource :new_project, controller: "/admin/settings/new_project_settings", only: %i[show update]
       resources :project_custom_fields, controller: "/admin/settings/project_custom_fields" do
diff --git a/frontend/src/stimulus/controllers/dynamic/admin/work-packages-settings.controller.ts b/frontend/src/stimulus/controllers/dynamic/admin/progress-tracking.controller.ts
similarity index 97%
rename from frontend/src/stimulus/controllers/dynamic/admin/work-packages-settings.controller.ts
rename to frontend/src/stimulus/controllers/dynamic/admin/progress-tracking.controller.ts
index 6dc3e76c2355..fcba621f68d6 100644
--- a/frontend/src/stimulus/controllers/dynamic/admin/work-packages-settings.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/admin/progress-tracking.controller.ts
@@ -30,7 +30,7 @@
 
 import { Controller } from '@hotwired/stimulus';
 
-export default class WorkPackagesSettingsController extends Controller {
+export default class ProgressTrackingController extends Controller {
   static values = {
     percentCompleteEditionActive: Boolean,
   };
diff --git a/spec/controllers/admin/settings/progress_tracking_controller_spec.rb b/spec/controllers/admin/settings/progress_tracking_controller_spec.rb
new file mode 100644
index 000000000000..20485f8328b3
--- /dev/null
+++ b/spec/controllers/admin/settings/progress_tracking_controller_spec.rb
@@ -0,0 +1,100 @@
+# 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.
+# ++
+#
+
+require "spec_helper"
+
+RSpec.describe Admin::Settings::ProgressTrackingController do
+  shared_let(:user) { create(:admin) }
+
+  current_user { user }
+
+  include_examples "GET #show requires admin permission and renders template", path: "progress_tracking"
+
+  context "when changing progress calculation from work-based to status-based" do
+    shared_let(:status) { create(:status, default_done_ratio: 42) }
+    shared_let(:work_package) { create(:work_package, status:, done_ratio: 10, estimated_hours: 100) }
+
+    before do
+      Setting.work_package_done_ratio = "field"
+    end
+
+    it "starts a job to update work packages % complete and remaining work values" do
+      patch "update",
+            params: {
+              settings: {
+                work_package_done_ratio: "status"
+              }
+            }
+      expect(Setting.work_package_done_ratio).to eq("status")
+      expect(WorkPackages::Progress::ApplyStatusesChangeJob)
+        .to have_been_enqueued.with(cause_type: "progress_mode_changed_to_status_based")
+
+      perform_enqueued_jobs
+
+      expect(work_package.reload.read_attribute(:done_ratio)).to eq(status.default_done_ratio)
+      expect(work_package.last_journal.details["cause"]).to eq([nil, { "type" => "progress_mode_changed_to_status_based" }])
+    end
+  end
+
+  context "when sending path request to change progress calculation from status-based to status-based" do
+    before do
+      Setting.work_package_done_ratio = "status"
+    end
+
+    it "does not start a job" do
+      patch "update",
+            params: {
+              settings: {
+                work_package_done_ratio: "status"
+              }
+            }
+      expect(WorkPackages::Progress::ApplyStatusesChangeJob)
+        .not_to have_been_enqueued
+    end
+  end
+
+  context "when changing progress calculation from status-based to work-based" do
+    before do
+      Setting.work_package_done_ratio = "status"
+    end
+
+    it "does not start a job" do
+      patch "update",
+            params: {
+              settings: {
+                work_package_done_ratio: "field"
+              }
+            }
+      expect(WorkPackages::Progress::ApplyStatusesChangeJob)
+        .not_to have_been_enqueued
+    end
+  end
+end
diff --git a/spec/controllers/admin/settings/work_packages_general_controller_spec.rb b/spec/controllers/admin/settings/work_packages_general_controller_spec.rb
index fb2d97be5dfd..a15fd3d4f576 100644
--- a/spec/controllers/admin/settings/work_packages_general_controller_spec.rb
+++ b/spec/controllers/admin/settings/work_packages_general_controller_spec.rb
@@ -37,64 +37,4 @@
   current_user { user }
 
   include_examples "GET #show requires admin permission and renders template", path: "work_packages_general"
-
-  context "when changing progress calculation from work-based to status-based" do
-    shared_let(:status) { create(:status, default_done_ratio: 42) }
-    shared_let(:work_package) { create(:work_package, status:, done_ratio: 10, estimated_hours: 100) }
-
-    before do
-      Setting.work_package_done_ratio = "field"
-    end
-
-    it "starts a job to update work packages % complete and remaining work values" do
-      patch "update",
-            params: {
-              settings: {
-                work_package_done_ratio: "status"
-              }
-            }
-      expect(Setting.work_package_done_ratio).to eq("status")
-      expect(WorkPackages::Progress::ApplyStatusesChangeJob)
-        .to have_been_enqueued.with(cause_type: "progress_mode_changed_to_status_based")
-
-      perform_enqueued_jobs
-
-      expect(work_package.reload.read_attribute(:done_ratio)).to eq(status.default_done_ratio)
-      expect(work_package.last_journal.details["cause"]).to eq([nil, { "type" => "progress_mode_changed_to_status_based" }])
-    end
-  end
-
-  context "when sending path request to change progress calculation from status-based to status-based" do
-    before do
-      Setting.work_package_done_ratio = "status"
-    end
-
-    it "does not start a job" do
-      patch "update",
-            params: {
-              settings: {
-                work_package_done_ratio: "status"
-              }
-            }
-      expect(WorkPackages::Progress::ApplyStatusesChangeJob)
-        .not_to have_been_enqueued
-    end
-  end
-
-  context "when changing progress calculation from status-based to work-based" do
-    before do
-      Setting.work_package_done_ratio = "status"
-    end
-
-    it "does not start a job" do
-      patch "update",
-            params: {
-              settings: {
-                work_package_done_ratio: "field"
-              }
-            }
-      expect(WorkPackages::Progress::ApplyStatusesChangeJob)
-        .not_to have_been_enqueued
-    end
-  end
 end

From 390d878f58721717fe457d637af3c15d9c013f83 Mon Sep 17 00:00:00 2001
From: Christophe Bliard <c.bliard@openproject.com>
Date: Wed, 11 Sep 2024 09:29:17 +0200
Subject: [PATCH 06/10] Start primerizing progress tracking admin section

The warning message is not yet implemented.
---
 app/components/op_primer/form_helpers.rb      |  97 ++++++++++++++++
 .../progress_calculation_mode_form.rb         |  44 +++++++
 app/forms/application_form.rb                 |  42 +++++++
 app/forms/settings_form_decorator.rb          | 108 ++++++++++++++++++
 app/helpers/application_helper.rb             |   1 +
 .../settings/progress_tracking/show.html.erb  |   7 ++
 config/locales/en.yml                         |   8 +-
 7 files changed, 306 insertions(+), 1 deletion(-)
 create mode 100644 app/components/op_primer/form_helpers.rb
 create mode 100644 app/forms/admin/settings/progress_tracking/progress_calculation_mode_form.rb
 create mode 100644 app/forms/application_form.rb
 create mode 100644 app/forms/settings_form_decorator.rb

diff --git a/app/components/op_primer/form_helpers.rb b/app/components/op_primer/form_helpers.rb
new file mode 100644
index 000000000000..9c6d465bfd26
--- /dev/null
+++ b/app/components/op_primer/form_helpers.rb
@@ -0,0 +1,97 @@
+# 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.
+#++
+
+module OpPrimer
+  module FormHelpers
+    # Renders an inline form without needing a dedicated form class.
+    #
+    # This method dynamically creates a form class based on the provided block
+    # and renders it. The form is instantiated with the provided form builder
+    # which comes from a `primer_form_with` call.
+    #
+    # It is meant to avoid boilerplate classes for simple forms.
+    #
+    # @example
+    #   primer_form_with(action: :update) do |form_builder|
+    #     render_inline_form(form_builder) do |form|
+    #       form.text_field(
+    #         name: :ultimate_answer,
+    #         label: "Ultimate answer",
+    #         required: true,
+    #         caption: "The answer to life, the universe, and everything"
+    #       )
+    #       form.submit(name: :submit, label: "Submit")
+    #     end
+    #   end
+    #
+    # @param f [Object] The form object to be used for the form.
+    # @param blk [Proc] A block that defines the form structure.
+    def render_inline_form(form_builder, &blk)
+      form_class = Class.new(ApplicationForm) do
+        form(&blk)
+      end
+      render(form_class.new(form_builder))
+    end
+
+    # Renders an inline settings form without needing a dedicated form class.
+    #
+    # This method dynamically creates a form class based on the provided block
+    # and renders it. The form is instantiated with the provided form builder
+    # which comes from a `primer_form_with` call, and decorated with the
+    # `settings_form` method.
+    #
+    # The settings form is providing helpers to render settings in a standard
+    # way by reading their value, rendering labels from their name, and checking
+    # if they are writable.
+    #
+    # It is meant to avoid boilerplate code.
+    #
+    # @example
+    #   primer_form_with(action: :update) do |f|
+    #     render_inline_settings_form(f) do |form|
+    #       form.text_field(name: :attachment_max_size)
+    #       form.radio_button_group(
+    #         name: "work_package_done_ratio",
+    #         values: WorkPackage::DONE_RATIO_OPTIONS
+    #       )
+    #       form.submit
+    #     end
+    #   end
+    #
+    # @param f [Object] The form object to be used for the form.
+    # @param blk [Proc] A block that defines the form structure.
+    def render_inline_settings_form(form_builder, &blk)
+      form_class = Class.new(ApplicationForm) do
+        settings_form(&blk)
+      end
+      render(form_class.new(form_builder))
+    end
+  end
+end
diff --git a/app/forms/admin/settings/progress_tracking/progress_calculation_mode_form.rb b/app/forms/admin/settings/progress_tracking/progress_calculation_mode_form.rb
new file mode 100644
index 000000000000..1c49792873a7
--- /dev/null
+++ b/app/forms/admin/settings/progress_tracking/progress_calculation_mode_form.rb
@@ -0,0 +1,44 @@
+# 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.
+#++
+
+module Admin
+  module Settings
+    module ProgressTracking
+      class ProgressCalculationModeForm < ApplicationForm
+        settings_form do |form|
+          form.radio_button_group(
+            name: "work_package_done_ratio",
+            values: WorkPackage::DONE_RATIO_OPTIONS
+          )
+        end
+      end
+    end
+  end
+end
diff --git a/app/forms/application_form.rb b/app/forms/application_form.rb
new file mode 100644
index 000000000000..4438a280917e
--- /dev/null
+++ b/app/forms/application_form.rb
@@ -0,0 +1,42 @@
+# 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 ApplicationForm < Primer::Forms::Base
+  def self.settings_form
+    form do |f|
+      f = SettingsFormDecorator.new(f)
+      yield f
+    end
+  end
+
+  def url_helpers
+    Rails.application.routes.url_helpers
+  end
+end
diff --git a/app/forms/settings_form_decorator.rb b/app/forms/settings_form_decorator.rb
new file mode 100644
index 000000000000..610b1c6e3050
--- /dev/null
+++ b/app/forms/settings_form_decorator.rb
@@ -0,0 +1,108 @@
+# 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 SettingsFormDecorator
+  attr_reader :form
+
+  def initialize(form)
+    @form = form
+  end
+
+  def method_missing(method, ...)
+    form.send(method, ...)
+  end
+
+  def respond_to_missing?(method, include_private = false)
+    form.respond_to?(method, include_private)
+  end
+
+  def text_field(name:, **options)
+    options.reverse_merge!(
+      label: setting_label(name),
+      value: setting_value(name),
+      disabled: setting_disabled?(name)
+    )
+    form.text_field(name:, **options)
+  end
+
+  def check_box(name:, **options)
+    options.reverse_merge!(
+      label: setting_label(name),
+      checked: setting_value(name),
+      disabled: setting_disabled?(name)
+    )
+    form.check_box(name:, **options)
+  end
+
+  def radio_button_group(name:, values:, **options)
+    radio_group_options = options.reverse_merge(
+      label: setting_label(name)
+    )
+    form.radio_button_group(
+      name:,
+      disabled: setting_disabled?(name),
+      **radio_group_options
+    ) do |radio_group|
+      values.each do |value|
+        button_options = options.merge(
+          value:,
+          checked: setting_value(name) == value,
+          label: setting_label(name, value),
+          caption: setting_caption_html(name, value)
+        )
+        radio_group.radio_button(**button_options)
+      end
+    end
+  end
+
+  def submit
+    form.submit(name: "submit",
+                label: I18n.t("button_save"),
+                scheme: :primary)
+  end
+
+  protected
+
+  def setting_label(*names)
+    I18n.t("setting_#{names.join('_')}")
+  end
+
+  def setting_caption_html(*names)
+    I18n.t("setting_#{names.join('_')}_caption_html").html_safe
+  end
+
+  def setting_value(name)
+    Setting[name]
+  end
+
+  def setting_disabled?(name)
+    !Setting.send(:"#{name}_writable?")
+  end
+end
diff --git a/app/helpers/application_helper.rb b/app/helpers/application_helper.rb
index f03f5ca75c93..d7cca379cf7a 100644
--- a/app/helpers/application_helper.rb
+++ b/app/helpers/application_helper.rb
@@ -33,6 +33,7 @@ module ApplicationHelper
   include OpenProject::TextFormatting
   include OpenProject::ObjectLinking
   include OpenProject::SafeParams
+  include OpPrimer::FormHelpers
   include I18n
   include ERB::Util
   include Redmine::I18n
diff --git a/app/views/admin/settings/progress_tracking/show.html.erb b/app/views/admin/settings/progress_tracking/show.html.erb
index 45e7dcb48f08..bc67d8dd0b71 100644
--- a/app/views/admin/settings/progress_tracking/show.html.erb
+++ b/app/views/admin/settings/progress_tracking/show.html.erb
@@ -38,6 +38,13 @@ See COPYRIGHT and LICENSE files for more details.
   end
 %>
 
+<%= primer_form_with(scope: :settings, action: :update, method: :patch) do |f| %>
+  <%= render Admin::Settings::ProgressTracking::ProgressCalculationModeForm.new(f) %>
+  <%=
+    render_inline_settings_form(f, &:submit)
+  %>
+<% end %>
+
 <%= styled_form_tag({ action: :update }, method: :patch) do %>
   <section class="form--section"
            data-application-target="dynamic"
diff --git a/config/locales/en.yml b/config/locales/en.yml
index b37a56f6a95f..fd7f24be11e1 100644
--- a/config/locales/en.yml
+++ b/config/locales/en.yml
@@ -3280,9 +3280,15 @@ en:
     This defines what is considered a "day" when displaying duration in days and hours
     (for example, if a day is 8 hours, 32 hours would be 4 days).
   setting_invitation_expiration_days: "Activation email expires after"
-  setting_work_package_done_ratio: "Progress calculation"
+  setting_work_package_done_ratio: "Progress calculation mode"
   setting_work_package_done_ratio_field: "Work-based"
+  setting_work_package_done_ratio_field_caption_html: >-
+    <i>% Complete</i> can be freely set to any value.
+    If you optionally enter a value for <i>Work</i>, <i>Remaining work</i> will automatically be derived.
   setting_work_package_done_ratio_status: "Status-based"
+  setting_work_package_done_ratio_status_caption_html: >-
+    Each status has a <i>% Complete</i> value associated with it.
+    Changing status will change <i>% Complete</i>.
   setting_work_package_done_ratio_explanation_pre_14_4_without_percent_complete_edition_html: >
     In <b>work-based</b> mode, % Complete is calculated from how much work is done in relation to total work.
     In <b>status-based</b> mode, each status has a % Complete value associated with it. Changing status will change % Complete.

From 61d2daa4cdb78d4e5181a7c2867a6510363354a2 Mon Sep 17 00:00:00 2001
From: Christophe Bliard <c.bliard@openproject.com>
Date: Wed, 11 Sep 2024 18:37:22 +0200
Subject: [PATCH 07/10] Display warning text when progress calculation changes

There is also a new helper to display HTML content in forms.
---
 .../progress_calculation_mode_form.rb         | 44 ------------
 app/forms/settings_form_decorator.rb          | 15 ++--
 .../settings/progress_tracking/show.html.erb  | 68 ++++++++----------
 .../admin/progress-tracking.controller.ts     | 24 ++++---
 .../forms/dsl/html_content_input.rb           | 28 ++++++++
 .../open_project/forms/dsl/input_methods.rb   |  4 ++
 .../open_project/forms/html_content.html.erb  |  1 +
 lib/primer/open_project/forms/html_content.rb | 21 ++++++
 spec/features/admin/progress_tracking_spec.rb | 72 +++++++++++++++++++
 9 files changed, 178 insertions(+), 99 deletions(-)
 delete mode 100644 app/forms/admin/settings/progress_tracking/progress_calculation_mode_form.rb
 create mode 100644 lib/primer/open_project/forms/dsl/html_content_input.rb
 create mode 100644 lib/primer/open_project/forms/html_content.html.erb
 create mode 100644 lib/primer/open_project/forms/html_content.rb
 create mode 100644 spec/features/admin/progress_tracking_spec.rb

diff --git a/app/forms/admin/settings/progress_tracking/progress_calculation_mode_form.rb b/app/forms/admin/settings/progress_tracking/progress_calculation_mode_form.rb
deleted file mode 100644
index 1c49792873a7..000000000000
--- a/app/forms/admin/settings/progress_tracking/progress_calculation_mode_form.rb
+++ /dev/null
@@ -1,44 +0,0 @@
-# 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.
-#++
-
-module Admin
-  module Settings
-    module ProgressTracking
-      class ProgressCalculationModeForm < ApplicationForm
-        settings_form do |form|
-          form.radio_button_group(
-            name: "work_package_done_ratio",
-            values: WorkPackage::DONE_RATIO_OPTIONS
-          )
-        end
-      end
-    end
-  end
-end
diff --git a/app/forms/settings_form_decorator.rb b/app/forms/settings_form_decorator.rb
index 610b1c6e3050..3d79ef6d4018 100644
--- a/app/forms/settings_form_decorator.rb
+++ b/app/forms/settings_form_decorator.rb
@@ -61,7 +61,7 @@ def check_box(name:, **options)
     form.check_box(name:, **options)
   end
 
-  def radio_button_group(name:, values:, **options)
+  def radio_button_group(name:, values:, button_options: {}, **options)
     radio_group_options = options.reverse_merge(
       label: setting_label(name)
     )
@@ -71,13 +71,14 @@ def radio_button_group(name:, values:, **options)
       **radio_group_options
     ) do |radio_group|
       values.each do |value|
-        button_options = options.merge(
-          value:,
-          checked: setting_value(name) == value,
-          label: setting_label(name, value),
-          caption: setting_caption_html(name, value)
+        radio_group.radio_button(
+          **button_options.reverse_merge(
+            value:,
+            checked: setting_value(name) == value,
+            label: setting_label(name, value),
+            caption: setting_caption_html(name, value)
+          )
         )
-        radio_group.radio_button(**button_options)
       end
     end
   end
diff --git a/app/views/admin/settings/progress_tracking/show.html.erb b/app/views/admin/settings/progress_tracking/show.html.erb
index bc67d8dd0b71..1231e32b00f1 100644
--- a/app/views/admin/settings/progress_tracking/show.html.erb
+++ b/app/views/admin/settings/progress_tracking/show.html.erb
@@ -38,41 +38,35 @@ See COPYRIGHT and LICENSE files for more details.
   end
 %>
 
-<%= primer_form_with(scope: :settings, action: :update, method: :patch) do |f| %>
-  <%= render Admin::Settings::ProgressTracking::ProgressCalculationModeForm.new(f) %>
-  <%=
-    render_inline_settings_form(f, &:submit)
-  %>
-<% end %>
-
-<%= styled_form_tag({ action: :update }, method: :patch) do %>
-  <section class="form--section"
-           data-application-target="dynamic"
-           data-controller="admin--progress-tracking"
-           data-admin--progress-tracking-percent-complete-edition-active-value="<%= OpenProject::FeatureDecisions.percent_complete_edition_active? %>">
-    <div class="form--field">
-      <%= setting_select :work_package_done_ratio,
-                         WorkPackage::DONE_RATIO_OPTIONS.collect { |i| [t("setting_work_package_done_ratio_#{i}"), i] },
-                         container_class: "-middle",
-                         data: { admin__progress_tracking_target: "progressCalculationModeSelect",
-                                 action: "admin--progress-tracking#displayWarning" } %>
-      <div class="form--field-instructions"><%=
-        if OpenProject::FeatureDecisions.percent_complete_edition_active?
-          t("setting_work_package_done_ratio_explanation_html")
-        else
-          # This condition branch to be removed in 15.0 with :percent_complete_edition feature flag removal
-          t("setting_work_package_done_ratio_explanation_pre_14_4_without_percent_complete_edition_html")
+<%=
+primer_form_with(
+  scope: :settings, action: :update, method: :patch,
+  data: {
+    application_target: "dynamic",
+    controller: "admin--progress-tracking",
+    admin__progress_tracking_target: "progressCalculationModeRadioGroup",
+    admin__progress_tracking_percent_complete_edition_active_value: OpenProject::FeatureDecisions.percent_complete_edition_active?,
+    admin__progress_tracking_initial_mode_value: Setting.work_package_done_ratio
+  }
+) do |f|
+  render_inline_settings_form(f) do |form|
+    form.radio_button_group(
+      name: "work_package_done_ratio",
+      values: WorkPackage::DONE_RATIO_OPTIONS,
+      button_options: {
+        data: { action: "admin--progress-tracking#displayWarning" }
+      }
+    )
+    form.html_content do
+      tag.div(class: "op-toast -warning -with-bottom-spacing",
+              hidden: true,
+              data: { admin__progress_tracking_target: "warningToast" }) do
+        tag.div(class: "op-toast--content") do
+          tag.p(data: { admin__progress_tracking_target: "warningText" })
         end
-                                            %></div>
-    </div>
-    <div class="op-toast -warning -with-bottom-spacing"
-         hidden
-         data-admin--progress-tracking-target="warningToast">
-      <div class="op-toast--content">
-        <p data-admin--progress-tracking-target="warningText"></p>
-      </div>
-    </div>
-  </section>
-
-  <%= styled_button_tag t(:button_save), class: "-primary -with-icon icon-checkmark" %>
-<% end %>
+      end
+    end
+    form.submit
+  end
+end
+%>
diff --git a/frontend/src/stimulus/controllers/dynamic/admin/progress-tracking.controller.ts b/frontend/src/stimulus/controllers/dynamic/admin/progress-tracking.controller.ts
index fcba621f68d6..05f3b5f97b63 100644
--- a/frontend/src/stimulus/controllers/dynamic/admin/progress-tracking.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/admin/progress-tracking.controller.ts
@@ -32,25 +32,22 @@ import { Controller } from '@hotwired/stimulus';
 
 export default class ProgressTrackingController extends Controller {
   static values = {
+    initialMode: String,
     percentCompleteEditionActive: Boolean,
   };
 
   static targets = [
-    'progressCalculationModeSelect',
+    'progressCalculationModeRadioGroup',
     'warningText',
     'warningToast',
   ];
 
+  declare readonly initialModeValue:string;
   declare readonly percentCompleteEditionActiveValue:boolean;
 
-  declare readonly progressCalculationModeSelectTarget:HTMLSelectElement;
+  declare readonly progressCalculationModeRadioGroupTarget:HTMLElement;
   declare readonly warningTextTarget:HTMLElement;
   declare readonly warningToastTarget:HTMLElement;
-  private initialMode:string;
-
-  connect() {
-    this.initialMode = this.progressCalculationModeSelectTarget.value;
-  }
 
   displayWarning() {
     const warningMessageHtml = this.getWarningMessageHtml();
@@ -62,21 +59,26 @@ export default class ProgressTrackingController extends Controller {
     }
   }
 
+  getSelectedMode() {
+    const checkedRadio = this.progressCalculationModeRadioGroupTarget.querySelector('input:checked') as HTMLInputElement;
+    return checkedRadio?.value || '';
+  }
+
   getWarningMessageHtml():string {
-    const newMode = this.progressCalculationModeSelectTarget.value;
-    if (newMode === this.initialMode) {
+    const selectedMode = this.getSelectedMode();
+    if (selectedMode === this.initialModeValue || !selectedMode) {
       return '';
     }
 
     // to be removed in 15.0 with :percent_complete_edition feature flag removal
-    if (!this.percentCompleteEditionActiveValue && newMode === 'field') {
+    if (!this.percentCompleteEditionActiveValue && selectedMode === 'field') {
       return I18n.t(
         'js.admin.work_packages_settings.warning_progress_calculation_mode_change_from_status_to_field_pre_14_4_without_percent_complete_edition_html',
       );
     }
 
     return I18n.t(
-      `js.admin.work_packages_settings.warning_progress_calculation_mode_change_from_${this.initialMode}_to_${newMode}_html`,
+      `js.admin.work_packages_settings.warning_progress_calculation_mode_change_from_${this.initialModeValue}_to_${selectedMode}_html`,
     );
   }
 }
diff --git a/lib/primer/open_project/forms/dsl/html_content_input.rb b/lib/primer/open_project/forms/dsl/html_content_input.rb
new file mode 100644
index 000000000000..95e720501e79
--- /dev/null
+++ b/lib/primer/open_project/forms/dsl/html_content_input.rb
@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Primer
+  module OpenProject
+    module Forms
+      module Dsl
+        class HtmlContentInput < Primer::Forms::Dsl::Input
+          def initialize(**system_arguments, &html_block)
+            @html_block = html_block
+
+            super(**system_arguments)
+          end
+
+          def to_component
+            HtmlContent.new(&@html_block)
+          end
+
+          def type
+            :html_content
+          end
+
+          def name = nil
+          def form_control? = false
+        end
+      end
+    end
+  end
+end
diff --git a/lib/primer/open_project/forms/dsl/input_methods.rb b/lib/primer/open_project/forms/dsl/input_methods.rb
index 8b9a74cf3d9a..bfb569e38ad0 100644
--- a/lib/primer/open_project/forms/dsl/input_methods.rb
+++ b/lib/primer/open_project/forms/dsl/input_methods.rb
@@ -24,6 +24,10 @@ def rich_text_area(**)
           def storage_manual_project_folder_selection(**)
             add_input StorageManualProjectFolderSelectionInput.new(builder: @builder, form: @form, **)
           end
+
+          def html_content(**, &)
+            add_input HtmlContentInput.new(builder: @builder, form: @form, **, &)
+          end
         end
       end
     end
diff --git a/lib/primer/open_project/forms/html_content.html.erb b/lib/primer/open_project/forms/html_content.html.erb
new file mode 100644
index 000000000000..0d6a044df122
--- /dev/null
+++ b/lib/primer/open_project/forms/html_content.html.erb
@@ -0,0 +1 @@
+<%= rendered_html_content %>
diff --git a/lib/primer/open_project/forms/html_content.rb b/lib/primer/open_project/forms/html_content.rb
new file mode 100644
index 000000000000..e25c65bf857f
--- /dev/null
+++ b/lib/primer/open_project/forms/html_content.rb
@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module Primer
+  module OpenProject
+    module Forms
+      # :nodoc:
+      class HtmlContent < Primer::Forms::BaseComponent
+        def initialize(&html_block)
+          super()
+          @html_block = html_block
+        end
+
+        def rendered_html_content
+          @view_context.capture do
+            @view_context.instance_exec(&@html_block)
+          end
+        end
+      end
+    end
+  end
+end
diff --git a/spec/features/admin/progress_tracking_spec.rb b/spec/features/admin/progress_tracking_spec.rb
new file mode 100644
index 000000000000..8cfa7d3db5f1
--- /dev/null
+++ b/spec/features/admin/progress_tracking_spec.rb
@@ -0,0 +1,72 @@
+#-- 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.
+#++
+
+require "spec_helper"
+
+RSpec.describe "Progress tracking admin page", :cuprite, :js,
+               with_flag: { percent_complete_edition: true } do
+  include ActionView::Helpers::SanitizeHelper
+  include Toasts::Expectations
+
+  shared_let(:admin) { create(:admin) }
+
+  it "displays a warning when changing progress calculation mode" do
+    Setting.work_package_done_ratio = "field"
+    login_as(admin)
+    visit admin_settings_progress_tracking_path
+
+    # change from work-based to status-based
+    expect(page).to have_field("Work-based", checked: true)
+    expect(page).to have_field("Status-based", checked: false)
+
+    find(:radio_button, "Status-based").click
+
+    expected_warning_text =
+      I18n.t("js.admin.work_packages_settings.warning_progress_calculation_mode_change_from_field_to_status_html")
+    expected_warning_text = strip_tags(expected_warning_text)[..80] # take only the beginning of the text
+    expect(page).to have_text(expected_warning_text)
+
+    click_on "Save"
+    expect_and_dismiss_toaster(message: "Successful update.")
+    expect(Setting.find_by(name: "work_package_done_ratio").value).to eq("status")
+
+    # now change from status-based to work-based
+    expect(page).to have_field("Work-based", checked: false)
+    expect(page).to have_field("Status-based", checked: true)
+
+    find(:radio_button, "Work-based").click
+    expected_warning_text =
+      I18n.t("js.admin.work_packages_settings.warning_progress_calculation_mode_change_from_status_to_field_html")
+    expected_warning_text = strip_tags(expected_warning_text)[..80] # take only the beginning of the text
+    expect(page).to have_text(expected_warning_text)
+
+    click_on "Save"
+    expect_and_dismiss_toaster(message: "Successful update.")
+    expect(Setting.find_by(name: "work_package_done_ratio").value).to eq("field")
+  end
+end

From a88260ce8da00aaa850d968b8333f363f9e85adf Mon Sep 17 00:00:00 2001
From: Christophe Bliard <c.bliard@openproject.com>
Date: Thu, 12 Sep 2024 11:33:59 +0200
Subject: [PATCH 08/10] Add lookbook Form pattern page

---
 lookbook/docs/patterns/14-forms.md.erb | 228 +++++++++++++++++++++++++
 1 file changed, 228 insertions(+)
 create mode 100644 lookbook/docs/patterns/14-forms.md.erb

diff --git a/lookbook/docs/patterns/14-forms.md.erb b/lookbook/docs/patterns/14-forms.md.erb
new file mode 100644
index 000000000000..18199a8afacb
--- /dev/null
+++ b/lookbook/docs/patterns/14-forms.md.erb
@@ -0,0 +1,228 @@
+Forms are used heavily in administration pages and throughout the application.
+They rely on Primer forms with some OpenProject specific components and helpers.
+
+## Overview
+
+<%= embed Primer::FormsPreview, :custom_width_fields_form, log: true %>
+
+## Usage
+
+To create forms, you need 2 basic things:
+
+- A form instance to render fields
+- A `primer_form_with` call to get a form builder and render the form instance
+
+```ruby
+class TextFieldAndCheckboxForm < ApplicationForm
+  form do |my_form|
+    my_form.text_field(
+      name: :ultimate_answer,
+      label: "Ultimate answer",
+      required: true,
+      caption: "The answer to life, the universe, and everything"
+    )
+
+    my_form.check_box(
+      name: :enable_ipd,
+      label: "Enable the Infinite Improbability Drive",
+      caption: "Cross interstellar distances in a mere nothingth of a second."
+    )
+  end
+end
+```
+
+```erb
+<%%= primer_form_with(url: "/foo") do |f| %>
+  <%%= render(TextFieldAndCheckboxForm.new(f)) %>
+<%% end %>
+```
+
+Multiple form instances can be rendered within the same `primer_form_with` call,
+allowing to put some content in between:
+
+```erb
+<%%= primer_form_with(url: "/foo") do |f| %>
+  <%%= render(TextFieldAndCheckboxForm.new(f)) %>
+  <%%= render(MessageComponent.new(icon: :info, message: "This will be fine!")) %>
+  <%%= render(SubmitButtonForm.new(f)) %>
+<%% end %>
+```
+
+This is the regular way of using Primer forms.
+
+## OpenProject helpers
+
+OpenProject provides some helpers to make building and rendering forms easier.
+
+### `render_inline_form` to avoid creating form classes
+
+This helper allows to render an anymous form instance, avoiding the need to
+create a dedicated form class. This can be useful for simple forms or when you
+don't want to pollute the form class namespace.
+
+```ruby
+class TextFieldWithWarningForm < ApplicationForm
+  attr_reader :warning
+
+  def initialize(warning: nil)
+    super()
+    @warning = warning
+  end
+
+  form do |my_form|
+    my_form.text_field(
+      name: :answer,
+      label: "answer",
+      required: true
+    )
+
+    if warning
+      my_form.html_content do
+        tag.div(class: "flash flash-warn") { warning }
+      end
+    end
+
+    my_form.submit(name: :submit, label: "Save")
+  end
+end
+```
+
+### `FormObject#html_content` to mix form fields and html content
+
+This helper allows to render non-form content in a form. For instance it can be
+used to render a description box inside a form, an image, or whatever makes
+sense for the form being built.
+
+```erb
+<%%= primer_form_with(url: "/foo") do |f| %>
+  <%%= render(TextFieldAndCheckboxForm.new(f)) %>
+  <%%= f.html_content do %>
+    <%%= render(MessageComponent.new(icon: :info, message: "This will be fine!")) %>
+  <%% end %>
+<%% end %>
+```
+
+## Forms for administration pages
+
+Administration pages forms are used to change the values of `Settings`. The name
+and labels being used are standardized making them very repetitive.
+
+Here is how the form of the General tab of the system administration page could
+look like:
+
+```ruby
+class Admin::Settings::GeneralSettingsForm < ApplicationForm
+  attr_reader :guessed_host
+
+  def initialize(guessed_host:)
+    super()
+    @guessed_host = guessed_host
+  end
+
+  form do |general_form|
+    general_form.text_field(
+      name: :app_title,
+      label: I18n.t("setting_app_title"),
+      value: Setting[:app_title],
+      disabled: !Setting.app_title_writable?
+    )
+    general_form.text_field(
+      name: :per_page_options,
+      label: I18n.t("setting_per_page_options"),
+      value: Setting[:per_page_options],
+      caption: "#{I18n.t(:text_comma_separated)}<br/>" \
+               "#{I18n.t(:text_notice_too_many_values_are_inperformant)}".html_safe)
+      disabled: !Setting.per_page_options_writable?
+    )
+    general_form.text_field(
+      name: :activity_days_default,
+      label: I18n.t("setting_activity_days_default"),
+      value: Setting[:activity_days_default],
+      type: :number,
+      disabled: !Setting.activity_days_default_writable?
+    )
+    general_form.text_field(
+      name: :host_name,
+      label: I18n.t("setting_host_name"),
+      value: Setting[:host_name],
+      caption: "#{I18n.t(:label_example)}: #{guessed_host}"),
+      disabled: !Setting.host_name_writable?
+    )
+    #
+    # and so on...
+    #
+    general_form.submit(
+      name: 'submit',
+      label: I18n.t('button_save'),
+      scheme: :primary
+    )
+  end
+end
+```
+
+There is a lot of repetition in the form above: the field can be disabled for
+read-only settings (which happens for settings set through environment variables
+or configuration files), the field name has to be translated and the value must
+be read from `Settings`. Entering all this information manually is tedious and
+error prone.
+
+In this case, `settings_form` can be usedinstead of `form` to get a form
+instance with knowledge about to render fields for settings.
+
+The above example then becomes:
+
+```ruby
+class Admin::Settings::GeneralSettingsForm < ApplicationForm
+  attr_reader :guessed_host
+
+  def initialize(guessed_host:)
+    super()
+    @guessed_host = guessed_host
+  end
+
+  settings_form do |general_form|
+    general_form.text_field(name: :app_title)
+    general_form.text_field(name: :per_page_options,
+                            caption: "#{I18n.t(:text_comma_separated)}<br/>" \
+                                     "#{I18n.t(:text_notice_too_many_values_are_inperformant)}".html_safe)
+    general_form.text_field(name: :activity_days_default,
+                            type: :number)
+    general_form.text_field(name: :host_name,
+                            caption: "#{I18n.t(:label_example)}: #{guessed_host}")
+    #
+    # and so on...
+    #
+    general_form.submit
+  end
+end
+```
+
+It is easier to write and read.
+
+Under the hood, the form object is decorated with `SettingsFormDecorator`.
+That's where all the helper methods are defined. There are not much for now, but
+this is intended to grow to support more advanced form features for
+administration pages.
+
+So far, the following helpers are available:
+
+  * `text_field(name:, **options)`: renders a text field for the setting called
+  `name`, automatically setting the label, value, and disabled state from the
+  setting's attributes.
+
+  * `check_box(name:, **options)`: renders a checkbox for the setting called
+  `name`, automatically setting the label, checked state, and disabled state
+  from the setting's attributes.
+
+  * `radio_button_group(name:, values:, button_options: {}, **options)`: renders
+  a radio button group for the setting called `name` and radio button for each
+  element of `values`, automatically setting the label, checked state, html
+  caption, and disabled state from the setting's attributes.
+
+  * `submit`: renders a submit button with the label "Save" and the primary
+  scheme.
+
+  * `form`: the form builder instance if you need to render some form elements
+  normally handled by the settings form decorator in another way than intended.
+  Any call to a method that is not defined on the settings form decorator will
+  be forwarded to this form builder instance so its usage is transparent.

From 348fea6a42981ad6fd8cc98c14ba0f55e9850bc1 Mon Sep 17 00:00:00 2001
From: Christophe Bliard <c.bliard@openproject.com>
Date: Thu, 12 Sep 2024 11:49:08 +0200
Subject: [PATCH 09/10] Check if warning should be displayed on connect

This is to display the warning when the user changes the calculation
mode and then reloads the page, or when the user changes the calculation
mode, navigates away and then goes back to the settings page.
---
 .../controllers/dynamic/admin/progress-tracking.controller.ts | 4 ++++
 1 file changed, 4 insertions(+)

diff --git a/frontend/src/stimulus/controllers/dynamic/admin/progress-tracking.controller.ts b/frontend/src/stimulus/controllers/dynamic/admin/progress-tracking.controller.ts
index 05f3b5f97b63..5047fe4f6dd2 100644
--- a/frontend/src/stimulus/controllers/dynamic/admin/progress-tracking.controller.ts
+++ b/frontend/src/stimulus/controllers/dynamic/admin/progress-tracking.controller.ts
@@ -49,6 +49,10 @@ export default class ProgressTrackingController extends Controller {
   declare readonly warningTextTarget:HTMLElement;
   declare readonly warningToastTarget:HTMLElement;
 
+  connect() {
+    this.displayWarning();
+  }
+
   displayWarning() {
     const warningMessageHtml = this.getWarningMessageHtml();
     if (warningMessageHtml) {

From a3a221fdaa85760596dad628ce6461e4e23b54f4 Mon Sep 17 00:00:00 2001
From: Christophe Bliard <c.bliard@openproject.com>
Date: Fri, 13 Sep 2024 08:35:26 +0200
Subject: [PATCH 10/10] Fixes from PR review

Co-authored-by: Aaron Contreras <aaronlcaq@gmail.com>
---
 app/components/op_primer/form_helpers.rb      |  4 +-
 lookbook/docs/patterns/14-forms.md.erb        | 55 ++++++++++++-------
 .../aggregation_settings_controller_spec.rb   |  2 +-
 3 files changed, 38 insertions(+), 23 deletions(-)

diff --git a/app/components/op_primer/form_helpers.rb b/app/components/op_primer/form_helpers.rb
index 9c6d465bfd26..fb742d2a5d4a 100644
--- a/app/components/op_primer/form_helpers.rb
+++ b/app/components/op_primer/form_helpers.rb
@@ -51,7 +51,7 @@ module FormHelpers
     #     end
     #   end
     #
-    # @param f [Object] The form object to be used for the form.
+    # @param form_builder [Object] The form builder object to be used for the form.
     # @param blk [Proc] A block that defines the form structure.
     def render_inline_form(form_builder, &blk)
       form_class = Class.new(ApplicationForm) do
@@ -85,7 +85,7 @@ def render_inline_form(form_builder, &blk)
     #     end
     #   end
     #
-    # @param f [Object] The form object to be used for the form.
+    # @param form_builder [Object] The form builder object to be used for the form.
     # @param blk [Proc] A block that defines the form structure.
     def render_inline_settings_form(form_builder, &blk)
       form_class = Class.new(ApplicationForm) do
diff --git a/lookbook/docs/patterns/14-forms.md.erb b/lookbook/docs/patterns/14-forms.md.erb
index 18199a8afacb..1c1598b39cba 100644
--- a/lookbook/docs/patterns/14-forms.md.erb
+++ b/lookbook/docs/patterns/14-forms.md.erb
@@ -60,6 +60,36 @@ This helper allows to render an anymous form instance, avoiding the need to
 create a dedicated form class. This can be useful for simple forms or when you
 don't want to pollute the form class namespace.
 
+The above example which was needing a dedicated `TextFieldAndCheckboxForm` form
+class can be rewritten like this:
+
+```erb
+<%%=
+primer_form_with(url: "/foo") do |f|
+  render_inline_form(f) do |my_form|
+    my_form.text_field(
+      name: :ultimate_answer,
+      label: "Ultimate answer",
+      required: true,
+      caption: "The answer to life, the universe, and everything"
+    )
+
+    my_form.check_box(
+      name: :enable_ipd,
+      label: "Enable the Infinite Improbability Drive",
+      caption: "Cross interstellar distances in a mere nothingth of a second."
+    )
+  end
+end
+%>
+```
+
+### `FormObject#html_content` to mix form fields and html content
+
+This helper allows to render non-form content in a form. For instance it can be
+used to render a description box inside a form, an image, or whatever makes
+sense for the form being built.
+
 ```ruby
 class TextFieldWithWarningForm < ApplicationForm
   attr_reader :warning
@@ -71,8 +101,8 @@ class TextFieldWithWarningForm < ApplicationForm
 
   form do |my_form|
     my_form.text_field(
-      name: :answer,
-      label: "answer",
+      name: :full_name,
+      label: "Full name",
       required: true
     )
 
@@ -87,21 +117,6 @@ class TextFieldWithWarningForm < ApplicationForm
 end
 ```
 
-### `FormObject#html_content` to mix form fields and html content
-
-This helper allows to render non-form content in a form. For instance it can be
-used to render a description box inside a form, an image, or whatever makes
-sense for the form being built.
-
-```erb
-<%%= primer_form_with(url: "/foo") do |f| %>
-  <%%= render(TextFieldAndCheckboxForm.new(f)) %>
-  <%%= f.html_content do %>
-    <%%= render(MessageComponent.new(icon: :info, message: "This will be fine!")) %>
-  <%% end %>
-<%% end %>
-```
-
 ## Forms for administration pages
 
 Administration pages forms are used to change the values of `Settings`. The name
@@ -166,8 +181,8 @@ or configuration files), the field name has to be translated and the value must
 be read from `Settings`. Entering all this information manually is tedious and
 error prone.
 
-In this case, `settings_form` can be usedinstead of `form` to get a form
-instance with knowledge about to render fields for settings.
+In this case, `settings_form` can be used instead of `form` to get a form
+instance with knowledge about how render fields for settings.
 
 The above example then becomes:
 
@@ -200,7 +215,7 @@ end
 It is easier to write and read.
 
 Under the hood, the form object is decorated with `SettingsFormDecorator`.
-That's where all the helper methods are defined. There are not much for now, but
+That's where all the helper methods are defined. There aren't many for now, but
 this is intended to grow to support more advanced form features for
 administration pages.
 
diff --git a/spec/controllers/admin/settings/aggregation_settings_controller_spec.rb b/spec/controllers/admin/settings/aggregation_settings_controller_spec.rb
index 9495179af8a4..93ed0c63a785 100644
--- a/spec/controllers/admin/settings/aggregation_settings_controller_spec.rb
+++ b/spec/controllers/admin/settings/aggregation_settings_controller_spec.rb
@@ -34,7 +34,7 @@
 RSpec.describe Admin::Settings::AggregationSettingsController do
   shared_let(:user) { create(:admin) }
 
-  shared_current_user { user }
+  current_user { user }
 
   include_examples "GET #show requires admin permission and renders template", path: "aggregation_settings"
 end