Files
openproject/app/controllers/admin/settings/project_custom_field_sections_controller.rb
Henriette Darge caa609d34c [61445] Configure project attribute sections to be shown as widgets on the project overview page (#20899)
* Show project attributes as sections in project overview

* Introduce a column "shown_in" for CustomFieldSection which defines whether the section shall be shown in the sidebar or the main section of the project overview

* Show only those attributes in main section that are configured to be shown there. Same for the sidebar.

* Update project attribute sections after editing them

* Write a test for the new positioning behavior of project attribute sections

* Rename "shown_in" with "display_representation" and make it a hash

* Provide proper default when creating a new section

* Enforce project attribute widgets to be in a new line and wrap properly

* Hide logic for moivng sections to the main area behind the feature flag

* Rename "main section" to "main area"

* Extract custom margins into normal sass

* Rename "side-panel" to "side panel"

* Update test to changed wording
2025-11-19 08:01:42 +01:00

130 lines
4.5 KiB
Ruby

# 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::Settings
class ProjectCustomFieldSectionsController < ::Admin::SettingsController
include OpTurbo::ComponentStream
include Admin::Settings::ProjectCustomFields::ComponentStreams
before_action :set_project_custom_field_section, only: %i[update move drop destroy]
def create
# show new sections at the top of the list, otherwise might not be visible to user
call = ::ProjectCustomFieldSections::CreateService.new(user: current_user).call(
project_custom_field_section_params.merge(position: 1)
)
if call.success?
update_header_via_turbo_stream(allow_custom_field_creation: allow_custom_field_creation?)
update_sections_via_turbo_stream(project_custom_field_sections: ProjectCustomFieldSection.all)
else
update_section_dialog_body_form_via_turbo_stream(project_custom_field_section: call.result)
end
respond_with_turbo_streams
end
def update
call = ::ProjectCustomFieldSections::UpdateService.new(user: current_user, model: @project_custom_field_section).call(
project_custom_field_section_params
)
if call.success?
update_section_via_turbo_stream(project_custom_field_section: call.result)
else
update_section_dialog_body_form_via_turbo_stream(project_custom_field_section: call.result)
end
respond_with_turbo_streams
end
def destroy
call = ::ProjectCustomFieldSections::DeleteService.new(user: current_user, model: @project_custom_field_section).call
if call.success?
update_header_via_turbo_stream(allow_custom_field_creation: allow_custom_field_creation?)
update_sections_via_turbo_stream(project_custom_field_sections: ProjectCustomFieldSection.all)
else
# TODO: show error message
end
respond_with_turbo_streams
end
def move
call = ::ProjectCustomFieldSections::UpdateService.new(user: current_user, model: @project_custom_field_section).call(
move_to: params[:move_to]&.to_sym
)
if call.success?
update_sections_via_turbo_stream(project_custom_field_sections: ProjectCustomFieldSection.all)
else
# TODO: show error message
end
respond_with_turbo_streams
end
def drop
call = ::ProjectCustomFieldSections::UpdateService.new(user: current_user, model: @project_custom_field_section).call(
position: params[:position].to_i
)
if call.success?
update_header_via_turbo_stream(allow_custom_field_creation: allow_custom_field_creation?)
update_sections_via_turbo_stream(project_custom_field_sections: ProjectCustomFieldSection.all)
else
# TODO: show error message
end
respond_with_turbo_streams
end
def new_link
respond_with_dialog Settings::ProjectCustomFieldSections::NewSectionDialogComponent.new
end
private
def set_project_custom_field_section
@project_custom_field_section = ProjectCustomFieldSection.find(params[:id])
end
def allow_custom_field_creation?
ProjectCustomFieldSection.any?
end
def project_custom_field_section_params
# Set the sidebar as default
params.require(:project_custom_field_section)[:overview] ||= CustomFieldSection::OVERVIEW__SIDEBAR_KEY
params.expect(project_custom_field_section: %i[name overview])
end
end
end