('[data-close-dialog-id]')!.click();
+ dialog.close();
+ await dialogClosed;
+
+ expect(checkbox.checked).toBe(true);
+ });
+
+ it('reverts the change when the dialog is closed without confirming', async () => {
+ const { checkbox, dialog } = await render({ checked: true });
+
+ toggle(checkbox);
+ const dialogClosed = closed(dialog);
+ dialog.close();
+ await dialogClosed;
+
+ expect(checkbox.checked).toBe(true);
+ });
+
+ it('does not ask for confirmation when changing to the other state', async () => {
+ const { checkbox, dialog } = await render({ checked: false });
+
+ toggle(checkbox);
+
+ expect(dialog.open).toBe(false);
+ });
+
+ it('asks for confirmation when checking with a checked trigger', async () => {
+ const { checkbox, dialog } = await render({ checked: false, trigger: 'checked' });
+
+ toggle(checkbox);
+
+ expect(dialog.open).toBe(true);
+ });
+});
diff --git a/frontend/src/stimulus/controllers/dynamic/checkbox-confirmation.controller.ts b/frontend/src/stimulus/controllers/dynamic/checkbox-confirmation.controller.ts
new file mode 100644
index 000000000000..bbfd86f2f1ae
--- /dev/null
+++ b/frontend/src/stimulus/controllers/dynamic/checkbox-confirmation.controller.ts
@@ -0,0 +1,90 @@
+//-- 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, see .
+//
+// See COPYRIGHT and LICENSE files for more details.
+//++
+
+import { Controller } from '@hotwired/stimulus';
+
+/**
+ * Opens a confirmation dialog when the checkbox is changed to the trigger state. The checkbox is
+ * changed back unless the change is confirmed with the dialog's submit button, which is marked by
+ * `data-submit-dialog-id` as with Primer dialogs.
+ */
+export default class CheckboxConfirmationController extends Controller {
+ static targets = ['checkbox', 'dialog'];
+
+ static values = {
+ trigger: { type: String, default: 'unchecked' },
+ };
+
+ declare readonly checkboxTarget:HTMLInputElement;
+ declare readonly dialogTarget:HTMLDialogElement;
+ declare readonly triggerValue:'checked'|'unchecked';
+
+ private confirmed = false;
+
+ checkboxTargetConnected(checkbox:HTMLInputElement):void {
+ checkbox.addEventListener('change', this.onChange);
+ }
+
+ checkboxTargetDisconnected(checkbox:HTMLInputElement):void {
+ checkbox.removeEventListener('change', this.onChange);
+ }
+
+ dialogTargetConnected(dialog:HTMLDialogElement):void {
+ dialog.addEventListener('click', this.onDialogClick);
+ dialog.addEventListener('close', this.onDialogClose);
+ }
+
+ dialogTargetDisconnected(dialog:HTMLDialogElement):void {
+ dialog.removeEventListener('click', this.onDialogClick);
+ dialog.removeEventListener('close', this.onDialogClose);
+ }
+
+ private onChange = ():void => {
+ if (this.checkboxTarget.checked === (this.triggerValue === 'checked')) {
+ this.confirmed = false;
+ this.dialogTarget.showModal();
+ }
+ };
+
+ // Primer closes the dialog on its own when the submit button is clicked.
+ private onDialogClick = (event:MouseEvent):void => {
+ if (!(event.target as Element).closest('[data-submit-dialog-id]')) {
+ return;
+ }
+
+ this.confirmed = true;
+ if (this.dialogTarget.open) {
+ this.dialogTarget.close();
+ }
+ };
+
+ private onDialogClose = ():void => {
+ if (!this.confirmed) {
+ this.checkboxTarget.checked = !this.checkboxTarget.checked;
+ }
+ };
+}
diff --git a/lookbook/docs/20-patterns/02-forms/03-interactivity.md.erb b/lookbook/docs/20-patterns/02-forms/03-interactivity.md.erb
index 419e32613f7c..575b6b9d9b45 100644
--- a/lookbook/docs/20-patterns/02-forms/03-interactivity.md.erb
+++ b/lookbook/docs/20-patterns/02-forms/03-interactivity.md.erb
@@ -69,6 +69,49 @@ Important data inputs:
- data: `{ target_name: "abc"}` or `data-target-name="abc"` allows you to define multiple sets of cause/effect handlers
- If you want the target to be visibly blocked, not hidden, then use `data: { set_visibility: "true" }`. By default, the field will be hidden and removed from DOM computation.
+## Confirming checkbox changes
+
+Some checkboxes have consequences that cannot be undone once the form is saved, for example disabling a setting removes all data configured for it. To ask for confirmation right when the checkbox is changed, use the Stimulus controller `checkbox-confirmation` together with a [Danger dialog](/lookbook/pages/components/dialogs/danger_dialog).
+
+<%= embed Patterns::CheckboxConfirmationPreview, :default %>
+
+To use it, attach the controller to an element containing both the checkbox and the dialog, and mark them as targets:
+
+```erb
+
+ <%%= primer_form_with(...) do |f| %>
+ <%%= render_inline_form(f) do |form| %>
+ <%% form.check_box(
+ name: :feature_enabled,
+ label: "Enable feature",
+ data: { checkbox_confirmation_target: "checkbox" }
+ ) %>
+ <%% end %>
+ <%% end %>
+
+ <%%= render(
+ Primer::OpenProject::DangerDialog.new(
+ id: "disable-feature-dialog",
+ title: "Disable feature",
+ confirm_button_text: "Disable",
+ data: { checkbox_confirmation_target: "dialog" }
+ )
+ ) do |dialog| %>
+ <%% dialog.with_confirmation_message do |message| %>
+ <%% message.with_heading(tag: :h2) { "Disable the feature?" } %>
+ <%% message.with_description_content("All data configured for it will be removed.") %>
+ <%% end %>
+ <%% end %>
+
+```
+
+How it behaves:
+
+- The dialog opens when the checkbox is unchecked. Pass `data-checkbox-confirmation-trigger-value="checked"` to ask for confirmation when it is checked instead.
+- The change is kept when it is confirmed with the dialog's submit button, i.e. the button marked with `data-submit-dialog-id`, which the Danger dialog renders as its confirm button.
+- Closing the dialog in any other way, by cancelling, closing it or pressing Escape, changes the checkbox back.
+- Only attach the controller when confirming is necessary, for example when there actually is data that would be removed. There is no option to skip the confirmation.
+- The dialog must not have `form_arguments`, as the checkbox is saved together with its own form.
## Advanced Interactivity by previewing forms before submission
@@ -130,7 +173,6 @@ In some cases we might want to further customize the triggering behavior, for ex
**Important note:** Javascript rendered elements inside the form such as the datepicker above, could be broken after the form update. This happens, because the datepicker input get replaced without re-initializing the datepicker library. To fix the issue, we can either avoid updating the datepicker input elements using "data-turbo-permanent", or we can programmatically re-initialize them after the form update. In case of angular components, this issue is solved automatically by not updating the components. For more info see the `turbo:before-morph-element` eventlistener in the `turbo-global-listeners.ts`.
-
### How to handle the form preview actions on the backend?
The form preview mechanism shown above can be nicely tied with our existing ActiveRecord object saving services.
@@ -139,7 +181,7 @@ The form preview mechanism shown above can be nicely tied with our existing Acti
```ruby
module WorkPackages
- class PreviewAttributesService < ::BaseServices::SetAttributes
+ class PreviewAttributesService <::BaseServices::SetAttributes
def perform(*)
super.tap do |service_call|
clear_unchanged_fields(service_call)
diff --git a/lookbook/previews/patterns/checkbox_confirmation_preview.rb b/lookbook/previews/patterns/checkbox_confirmation_preview.rb
new file mode 100644
index 000000000000..0f9b88b9d78c
--- /dev/null
+++ b/lookbook/previews/patterns/checkbox_confirmation_preview.rb
@@ -0,0 +1,39 @@
+# 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 Patterns
+ # @hidden
+ class CheckboxConfirmationPreview < ViewComponent::Preview
+ # @display min_height 400px
+ def default
+ render_with_template
+ end
+ end
+end
diff --git a/lookbook/previews/patterns/checkbox_confirmation_preview/default.html.erb b/lookbook/previews/patterns/checkbox_confirmation_preview/default.html.erb
new file mode 100644
index 000000000000..9d5b59323711
--- /dev/null
+++ b/lookbook/previews/patterns/checkbox_confirmation_preview/default.html.erb
@@ -0,0 +1,36 @@
+<%
+ the_form = Class.new(ApplicationForm) do
+ form do |f|
+ f.check_box(
+ name: :project_specific_values,
+ label: "Project-specific values",
+ checked: true,
+ data: { checkbox_confirmation_target: "checkbox" }
+ )
+ end
+ end
+%>
+
+
+ <%=
+ primer_form_with(url: "/abc", method: :post) do |f|
+ render(the_form.new(f))
+ end
+ %>
+
+ <%=
+ render(
+ Primer::OpenProject::DangerDialog.new(
+ id: "checkbox-confirmation-preview-dialog",
+ title: "Disable project-specific values",
+ confirm_button_text: "Disable",
+ data: { checkbox_confirmation_target: "dialog" }
+ )
+ ) do |dialog|
+ dialog.with_confirmation_message do |message|
+ message.with_heading(tag: :h2) { "Disable project-specific values?" }
+ message.with_description_content("All values enabled per project will be removed.")
+ end
+ end
+ %>
+
diff --git a/spec/components/admin/custom_fields/projects/values_component_spec.rb b/spec/components/admin/custom_fields/projects/values_component_spec.rb
new file mode 100644
index 000000000000..13913ab52278
--- /dev/null
+++ b/spec/components/admin/custom_fields/projects/values_component_spec.rb
@@ -0,0 +1,87 @@
+# 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 "rails_helper"
+
+RSpec.describe Admin::CustomFields::Projects::ValuesComponent, type: :component do
+ include Rails.application.routes.url_helpers
+
+ shared_let(:project) { create(:project) }
+
+ subject(:rendered) { render_inline(described_class.new(custom_field:, project:)) }
+
+ let(:row) { ->(value) { rendered.css("[data-test-selector='custom-field-project-value-#{value.id}']") } }
+
+ context "for a list custom field" do
+ let(:custom_field) { create(:list_wp_custom_field, :project_specific_allowlist, possible_values: %w[A B]) }
+ let(:option_a) { custom_field.custom_options.find_by!(value: "A") }
+ let(:option_b) { custom_field.custom_options.find_by!(value: "B") }
+
+ before do
+ create(:project_specific_value_restriction, project:, custom_option: option_a)
+ end
+
+ it "offers to enable and to disable all values" do
+ expect(rendered).to have_link(
+ I18n.t("custom_fields.admin.projects.enable_all"),
+ href: enable_all_project_values_admin_settings_work_package_custom_field_path(custom_field, project)
+ )
+ expect(rendered).to have_link(
+ I18n.t("custom_fields.admin.projects.disable_all"),
+ href: disable_all_project_values_admin_settings_work_package_custom_field_path(custom_field, project)
+ )
+ end
+
+ it "toggles each value on its own" do
+ expect(row.call(option_a).css("toggle-switch").attr("src").value)
+ .to eq(toggle_project_value_admin_settings_work_package_custom_field_path(custom_field, project, option_a.id))
+ end
+
+ it "lists the options in order with whether they are enabled in the project" do
+ expect(rendered.css("[data-test-selector^='custom-field-project-value-']").map { it.text.split.first })
+ .to eq(%w[A B])
+ expect(row.call(option_a).css("button[aria-pressed='true']")).to be_present
+ expect(row.call(option_b).css("button[aria-pressed='false']")).to be_present
+ end
+ end
+
+ context "for a weighted item list custom field", with_ee: [:weighted_item_lists] do
+ let(:custom_field) { create(:weighted_item_list_wp_custom_field, :project_specific_allowlist) }
+ let!(:parent) { create(:hierarchy_item, parent: custom_field.hierarchy_root, label: "High", weight: 10) }
+ let!(:child) { create(:hierarchy_item, parent:, label: "Urgent", weight: 15) }
+
+ it "indents sub-items and shows their weight and number of sub-items" do
+ expect(row.call(parent).text).to include("High", "10", I18n.t("custom_fields.admin.hierarchy.subitems", count: 1))
+ expect(row.call(child).text).to include("Urgent", "15")
+ expect(row.call(child).css(".pl-3")).to be_present
+ expect(row.call(parent).css(".pl-3")).to be_empty
+ end
+ end
+end
diff --git a/spec/components/custom_fields/details_component_spec.rb b/spec/components/custom_fields/details_component_spec.rb
index c4a34db862e8..e34b693eb9f0 100644
--- a/spec/components/custom_fields/details_component_spec.rb
+++ b/spec/components/custom_fields/details_component_spec.rb
@@ -63,6 +63,28 @@
end
end
+ describe "the confirmation for disabling project-specific values" do
+ let(:confirmation) { rendered.css("[data-controller~='checkbox-confirmation']") }
+
+ context "when project-specific values are enabled" do
+ let(:custom_field) { create(:list_wp_custom_field, :project_specific_allowlist) }
+
+ it "asks for confirmation before disabling them" do
+ expect(confirmation.css("input[data-checkbox-confirmation-target='checkbox']")).to be_present
+ expect(confirmation.css("dialog[data-checkbox-confirmation-target='dialog']")).to be_present
+ end
+ end
+
+ context "when project-specific values are not enabled" do
+ let(:custom_field) { create(:list_wp_custom_field) }
+
+ it "does not ask for confirmation" do
+ expect(confirmation).to be_empty
+ expect(rendered.css("dialog#disable-project-specific-values-dialog")).to be_empty
+ end
+ end
+ end
+
describe "for a project custom field" do
let(:custom_field) { create(:list_project_custom_field, possible_values: []) }
diff --git a/spec/forms/custom_fields/details_form_spec.rb b/spec/forms/custom_fields/details_form_spec.rb
index f577caace4ea..a7369d7978ab 100644
--- a/spec/forms/custom_fields/details_form_spec.rb
+++ b/spec/forms/custom_fields/details_form_spec.rb
@@ -30,7 +30,7 @@
require "rails_helper"
format_cases = {
- WorkPackageCustomField => %w[hierarchy],
+ WorkPackageCustomField => %w[hierarchy list weighted_item_list string],
TimeEntryCustomField => %w[text date float user version string bool list int],
VersionCustomField => %w[text date float int user bool string list version],
GroupCustomField => %w[text date float int bool list string],
@@ -48,6 +48,9 @@
custom_field_section_id: ->(model) { model.is_a?(ProjectCustomField) || model.is_a?(UserCustomField) },
has_comment: ->(model) { model.is_a?(ProjectCustomField) },
is_filter: ->(model) { model.is_a?(WorkPackageCustomField) },
+ project_specific_value_restriction: lambda { |model|
+ model.is_a?(WorkPackageCustomField) && %w[list hierarchy weighted_item_list].include?(model.field_format)
+ },
content_right_to_left: ->(model) { model.is_a?(WorkPackageCustomField) && model.field_format == "text" },
editable: ->(model) { model.is_a?(UserCustomField) },
visible_on_user_card: ->(model) { model.is_a?(UserCustomField) },
@@ -84,6 +87,8 @@ def field_label(field)
I18n.t("activerecord.attributes.project_custom_field.custom_field_section")
when :formula
I18n.t(:label_formula)
+ when :project_specific_value_restriction
+ I18n.t("custom_fields.project_specific_value_restriction_label")
else
I18n.t("activerecord.attributes.custom_field.#{field}")
end
@@ -136,4 +141,15 @@ def control_type(field)
end
end
end
+
+ context "with a WorkPackageCustomField with project-specific values" do
+ let(:model_class) { WorkPackageCustomField }
+ let(:field_format) { "list" }
+ let(:model) { model_class.new(field_format:, project_specific_value_restriction: "allow") }
+
+ it "renders the project-specific values checkbox checked" do
+ expect(page).to have_checked_field(I18n.t("custom_fields.project_specific_value_restriction_label"),
+ with: "allow")
+ end
+ end
end
diff --git a/spec/models/custom_field/project_specific_values_spec.rb b/spec/models/custom_field/project_specific_values_spec.rb
index 611568ab85ca..c8e9b6d6a78c 100644
--- a/spec/models/custom_field/project_specific_values_spec.rb
+++ b/spec/models/custom_field/project_specific_values_spec.rb
@@ -225,6 +225,42 @@
end
end
+ describe "#usable_value_counts_in" do
+ shared_let(:unconfigured_project) { create(:project) }
+
+ subject(:counts) { custom_field.usable_value_counts_in(Project.where(id: [project, other_project, unconfigured_project])) }
+
+ context "for a list custom field with an allowlist" do
+ let(:custom_field) { create(:list_wp_custom_field, :project_specific_allowlist, possible_values: %w[A B C]) }
+
+ before do
+ create(:project_specific_value_restriction, project:, custom_option: custom_field.custom_options.first)
+ create(:project_specific_value_restriction, project:, custom_option: custom_field.custom_options.second)
+ create(:project_specific_value_restriction, project: other_project, custom_option: custom_field.custom_options.third)
+ end
+
+ it "counts the options usable in each project" do
+ expect(counts).to eq(project.id => 2, other_project.id => 1, unconfigured_project.id => 0)
+ end
+ end
+
+ context "for a hierarchy custom field with an allowlist", with_ee: [:custom_field_hierarchies] do
+ let(:custom_field) { create(:hierarchy_wp_custom_field, :project_specific_allowlist) }
+ let!(:acme) { create(:hierarchy_item, parent: custom_field.hierarchy_root) }
+ let!(:anvils) { create(:hierarchy_item, parent: acme) }
+
+ before do
+ create(:project_specific_value_restriction, project:, hierarchy_item: acme)
+ create(:project_specific_value_restriction, project:, hierarchy_item: anvils)
+ create(:project_specific_value_restriction, project: other_project, hierarchy_item: anvils)
+ end
+
+ it "only counts the items whose ancestors are usable as well" do
+ expect(counts).to eq(project.id => 2, other_project.id => 0, unconfigured_project.id => 0)
+ end
+ end
+ end
+
describe "#visible_values_for" do
shared_let(:type) { create(:type) }
shared_let(:user) { create(:user) }
diff --git a/spec/models/queries/projects/filters/project_specific_values_filter_spec.rb b/spec/models/queries/projects/filters/project_specific_values_filter_spec.rb
new file mode 100644
index 000000000000..457b9b09f335
--- /dev/null
+++ b/spec/models/queries/projects/filters/project_specific_values_filter_spec.rb
@@ -0,0 +1,117 @@
+# 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 Queries::Projects::Filters::ProjectSpecificValuesFilter do
+ it_behaves_like "basic query filter" do
+ let(:class_key) { :project_specific_values }
+ let(:type) { :list }
+ let(:human_name) { "Project-specific values" }
+ end
+
+ describe "#available?" do
+ it "is offered to administrators only" do
+ allow(User).to receive(:current).and_return(build_stubbed(:admin))
+ expect(described_class.create!(name: :project_specific_values, operator: "=")).to be_available
+
+ allow(User).to receive(:current).and_return(build_stubbed(:user))
+ expect(described_class.create!(name: :project_specific_values, operator: "=")).not_to be_available
+ end
+ end
+
+ describe "#valid?" do
+ shared_let(:custom_field) { create(:list_wp_custom_field, :project_specific_allowlist) }
+
+ subject(:filter) do
+ described_class.create!(name: :project_specific_values, operator: "=", values: [custom_field.id.to_s])
+ end
+
+ context "for an administrator" do
+ current_user { build_stubbed(:admin) }
+
+ it { is_expected.to be_valid }
+ end
+
+ context "for a non-administrator" do
+ current_user { build_stubbed(:user) }
+
+ it { is_expected.not_to be_valid }
+ end
+ end
+
+ describe "#apply_to" do
+ shared_let(:custom_field) { create(:list_wp_custom_field, :project_specific_allowlist, possible_values: %w[A]) }
+ shared_let(:other_custom_field) { create(:list_wp_custom_field, :project_specific_allowlist, possible_values: %w[A]) }
+ shared_let(:configured_project) { create(:project) }
+ shared_let(:otherwise_configured_project) { create(:project) }
+ shared_let(:unconfigured_project) { create(:project) }
+
+ subject(:filter) do
+ described_class.create!(name: :project_specific_values, operator: "=", values: [custom_field.id.to_s])
+ end
+
+ before do
+ create(:project_specific_value_restriction, project: configured_project,
+ custom_option: custom_field.custom_options.first)
+ create(:project_specific_value_restriction, project: otherwise_configured_project,
+ custom_option: other_custom_field.custom_options.first)
+ end
+
+ it "keeps the projects with project-specific values of the custom field" do
+ expect(filter.apply_to(Project)).to contain_exactly(configured_project)
+ end
+ end
+
+ describe "in a project query" do
+ context "for an administrator" do
+ current_user { build_stubbed(:admin) }
+
+ it "is available, but not offered as an advanced filter" do
+ query = ProjectQuery.new
+
+ expect(query.available_filters.map(&:class)).to include(described_class)
+ expect(query.available_advanced_filters.map(&:class)).not_to include(described_class)
+ end
+ end
+
+ context "for a non-administrator" do
+ current_user { build_stubbed(:user) }
+
+ it "makes the query invalid" do
+ custom_field = create(:list_wp_custom_field, :project_specific_allowlist)
+ query = ProjectQuery.new.where(:project_specific_values, "=", [custom_field.id.to_s])
+
+ expect(query).not_to be_valid
+ expect(query.errors.full_messages.join).to include(I18n.t(:"activerecord.errors.messages.filter_does_not_exist"))
+ end
+ end
+ end
+end
diff --git a/spec/models/work_package_custom_field_spec.rb b/spec/models/work_package_custom_field_spec.rb
index aabb94e4cefb..56c445b63d3f 100644
--- a/spec/models/work_package_custom_field_spec.rb
+++ b/spec/models/work_package_custom_field_spec.rb
@@ -48,4 +48,24 @@
end
end
end
+
+ describe "#type_ids_by_project_id" do
+ let(:feature) { create(:type) }
+ let(:epic) { create(:type) }
+ let(:bug) { create(:type) }
+ let(:custom_field) { create(:list_wp_custom_field, types: [feature, epic]) }
+
+ let!(:project) { create(:project, types: [feature, epic, bug]) }
+ let!(:other_project) { create(:project, types: [feature]) }
+
+ before do
+ create(:project, types: [bug])
+ create(:project, active: false, types: [feature])
+ end
+
+ it "maps the active projects using the field to the types showing it there" do
+ expect(custom_field.type_ids_by_project_id)
+ .to match(project.id => contain_exactly(feature.id, epic.id), other_project.id => [feature.id])
+ end
+ end
end
diff --git a/spec/requests/admin/settings/work_package_custom_fields/projects_spec.rb b/spec/requests/admin/settings/work_package_custom_fields/projects_spec.rb
new file mode 100644
index 000000000000..0e8038e81b7d
--- /dev/null
+++ b/spec/requests/admin/settings/work_package_custom_fields/projects_spec.rb
@@ -0,0 +1,217 @@
+# 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 work package custom field projects", :skip_csrf, type: :rails_request do
+ shared_let(:admin) { create(:admin) }
+ shared_let(:feature) { create(:type, name: "Feature") }
+ shared_let(:epic) { create(:type, name: "Epic") }
+ shared_let(:using_project) { create(:project, name: "Using project", types: [feature, epic]) }
+ shared_let(:other_project) { create(:project, name: "Other project", types: [create(:type)]) }
+
+ let(:custom_field) do
+ create(:list_wp_custom_field, :project_specific_allowlist, types: [feature, epic], possible_values: %w[A B])
+ end
+ let(:projects_path) { projects_admin_settings_work_package_custom_field_path(custom_field) }
+ let(:page) { Capybara.string(response.body) }
+ let(:project_specific_values_filter) do
+ { project_specific_values: { operator: "=", values: [custom_field.id.to_s] } }
+ end
+
+ it "denies non-admins" do
+ login_as create(:user)
+ get projects_path
+
+ expect(response).to have_http_status(:forbidden)
+ end
+
+ context "as an admin" do
+ before do
+ login_as(admin)
+ end
+
+ context "with project-specific values enabled" do
+ before do
+ create(:project_specific_value_restriction, project: using_project,
+ custom_option: custom_field.custom_options.first)
+ get projects_path
+ end
+
+ it "lists the projects using the custom field with their types and enabled values" do
+ expect(response).to have_http_status(:ok)
+
+ row = page.find("[data-test-selector='custom-field-projects-row-#{using_project.id}']")
+ expect(row).to have_link("Feature")
+ expect(row).to have_link("Epic")
+ expect(row).to have_text("1 of 2")
+ end
+
+ it "does not list projects not using the custom field" do
+ expect(page).to have_no_text("Other project")
+ end
+
+ it "filters the projects by name" do
+ create(:project, name: "Another using project", types: [feature])
+
+ get projects_path, params: { filters: [{ name_and_identifier: { operator: "~", values: ["another"] } }].to_json }
+
+ expect(page).to have_link("Another using project")
+ expect(page).to have_no_link(using_project.name)
+ end
+
+ it "offers to only show the projects with project-specific values" do
+ expect(page).to have_link(I18n.t("custom_fields.admin.projects.quick_filter.with_project_specific_values"))
+ end
+
+ it "filters the projects with project-specific values" do
+ create(:project, name: "Unconfigured project", types: [feature])
+
+ get projects_path, params: { filters: [project_specific_values_filter].to_json }
+
+ expect(page).to have_link(using_project.name)
+ expect(page).to have_no_link("Unconfigured project")
+ end
+
+ context "with more projects than fit a page", with_settings: { per_page_options: "1, 100" } do
+ it "keeps the filters when paginating" do
+ another_project = create(:project, name: "Another using project", types: [feature])
+ create(:project_specific_value_restriction, project: another_project,
+ custom_option: custom_field.custom_options.first)
+ filters = [{ name_and_identifier: { operator: "~", values: ["using"] } }, project_specific_values_filter]
+
+ get projects_path, params: { filters: filters.to_json }
+
+ next_page = page.first("a[href*='page=2']")[:href]
+ next_page_filters = JSON.parse(Rack::Utils.parse_query(URI(next_page).query)["filters"])
+
+ expect(next_page_filters).to include(*filters.map(&:deep_stringify_keys))
+ end
+ end
+
+ it "shows a dedicated empty state when no project matches the filters" do
+ get projects_path,
+ params: { filters: [{ name_and_identifier: { operator: "~", values: ["no such project"] } }].to_json }
+
+ expect(page).to have_text(I18n.t("custom_fields.admin.projects.filter_no_results.title"))
+ expect(page).to have_no_text(I18n.t("custom_fields.admin.projects.empty_state.title"))
+ end
+
+ it "shows the projects tab" do
+ expect(page).to have_link(I18n.t(:label_project_plural), href: projects_path)
+ end
+
+ it "links each project name to the project" do
+ expect(page).to have_link(using_project.name, href: project_path(using_project))
+ end
+
+ it "links each project to the configuration of its values" do
+ values_path = project_values_admin_settings_work_package_custom_field_path(custom_field, using_project)
+
+ expect(page).to have_link(href: values_path)
+ end
+ end
+
+ describe "the values of a project" do
+ it "lists the values of the custom field for the project" do
+ get project_values_admin_settings_work_package_custom_field_path(custom_field, using_project)
+
+ expect(response).to have_http_status(:ok)
+ expect(page).to have_text("#{Project.model_name.human}: #{using_project.name}")
+ expect(page).to have_css("[data-test-selector='custom-field-project-value-#{custom_field.custom_options.first.id}']")
+ end
+
+ it "is not found for a project not using the custom field" do
+ get project_values_admin_settings_work_package_custom_field_path(custom_field, other_project)
+
+ expect(response).to have_http_status(:not_found)
+ end
+ end
+
+ describe "changing the values of a project" do
+ let(:option) { custom_field.custom_options.first }
+ let(:enabled_values) { custom_field.usable_values_in(using_project) }
+ let(:values_path) { project_values_admin_settings_work_package_custom_field_path(custom_field, using_project) }
+
+ it "enables a single value" do
+ post toggle_project_value_admin_settings_work_package_custom_field_path(custom_field, using_project, option.id),
+ params: { value: "1" }
+
+ expect(response).to have_http_status(:ok)
+ expect(enabled_values).to contain_exactly(option)
+ end
+
+ it "does not find a value of another custom field" do
+ other_option = create(:list_wp_custom_field).custom_options.first
+ post toggle_project_value_admin_settings_work_package_custom_field_path(custom_field, using_project, other_option.id),
+ params: { value: "1" }
+
+ expect(response).to have_http_status(:not_found)
+ end
+
+ it "enables all values" do
+ post enable_all_project_values_admin_settings_work_package_custom_field_path(custom_field, using_project)
+
+ expect(response).to redirect_to(values_path)
+ expect(enabled_values).to match_array(custom_field.custom_options)
+ end
+
+ it "disables all values" do
+ create(:project_specific_value_restriction, project: using_project, custom_option: option)
+ post disable_all_project_values_admin_settings_work_package_custom_field_path(custom_field, using_project)
+
+ expect(response).to redirect_to(values_path)
+ expect(enabled_values).to be_empty
+ end
+ end
+
+ context "without project-specific values enabled" do
+ let(:custom_field) { create(:list_wp_custom_field, types: [feature]) }
+
+ it "lists the projects without their project-specific values" do
+ get projects_path
+
+ expect(response).to have_http_status(:ok)
+ expect(page).to have_link(using_project.name, href: project_path(using_project))
+ expect(page).to have_no_text(CustomField.human_attribute_name(:project_specific_value_restriction))
+ expect(page).to have_no_link(
+ href: project_values_admin_settings_work_package_custom_field_path(custom_field, using_project)
+ )
+ expect(page).to have_no_link(I18n.t("custom_fields.admin.projects.quick_filter.with_project_specific_values"))
+ end
+
+ it "does not find the values of a project" do
+ get project_values_admin_settings_work_package_custom_field_path(custom_field, using_project)
+
+ expect(response).to have_http_status(:not_found)
+ end
+ end
+ end
+end