Skip to content

Issue #3555 - Added feature for Org admins can show/hide the #3579

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
johnpinto1 wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Issue #3555 - Added feature for Org admins can show/hide the #3579

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
929b661
Issue #3555 - Added feature for Org admins can show/hide the
Oct 22, 2025
bdbfefa
Updated migration add_add_ro_ethical_concerns_to_orgs for Rails version
Oct 27, 2025
af7d615
Refactored code for the Ethical Concerns block suggested during PR
Oct 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# Changelog

- Feature for Org admins can show/hide the ethical_issues field on plans [#3555](https://github.com/DMPRoadmap/roadmap/pull/3555).

## v5.0.2
- Bump Ruby to v3.1.4 and use `.ruby-version` in CI
- [#3566](https://github.com/DMPRoadmap/roadmap/pull/3566)
Expand Down
1 change: 1 addition & 0 deletions app/controllers/orgs_controller.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,7 @@ def org_params
.permit(:name, :abbreviation, :logo, :contact_email, :contact_name,
:remove_logo, :managed, :feedback_enabled, :org_links,
:funder, :institution, :organisation,
:add_ro_ethical_concerns,
:feedback_msg, :org_id, :org_name, :org_crosswalk,
:helpdesk_email,
identifiers_attributes: %i[identifier_scheme_id value],
Expand Down
1 change: 1 addition & 0 deletions app/models/org.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@
# region_id :integer
# managed :boolean default(false), not null
# helpdesk_email :string
# add_ro_ethical_concerns :boolean default(true), not null
#
# Foreign Keys
#
Expand Down
29 changes: 28 additions & 1 deletion app/views/orgs/_profile_form.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,8 +180,35 @@
</div>
<% end %>
</div>

<hr>
<%# Organisation Permissions block where super admin can add:
"Project details" tab in a plan
%>

<% org_perms_header_block = capture do %>
<h3>
<%= _('Organisation Permissions') %>
</h3>
<% end %>

<% add_ro_ethical_concerns_block = capture do %>
<div class="checkbox">
<%= f.label :add_ro_ethical_concerns do %>
<%= f.check_box :add_ro_ethical_concerns, { class: 'org_types', value: org.add_ro_ethical_concerns? }, "true", "false" %>
<%= _('Add "Research outputs may have ethical concerns" field to "Project details" tab in plans') %>
Copy link
Contributor

@aaronskiba aaronskiba Oct 27, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if these labels are a bit too literal and developer-y. What do we think of something more along the following lines?:
h3 title: "Organisation Customisations"
Checkbox caption: "Allow users to describe potential ethical issues in plans"

<% end %>
</div>
<% end %>

<% if current_user.can_org_admin? %>
Copy link
Contributor

@aaronskiba aaronskiba Oct 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had commented on a refactor before, but now I'm wondering if even the <% if current_user.can_org_admin? %> is redundant -- aren't org_admin privileges required to access this page in the first place?

Copy link
Contributor

@aaronskiba aaronskiba Oct 28, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe it should be changed to <% if Rails.configuration.x.madmp.enable_ethical_issues %>? That way the option is hidden if the global config value is set to false.

<div class="row">
<fieldset class="col-sm-8">
<%= org_perms_header_block %>
<%= add_ro_ethical_concerns_block %>
</fieldset>
</div>
<hr>
<% end %>

<% if !org.new_record? %>
<%= render partial: "orgs/external_identifiers",
Expand Down
12 changes: 11 additions & 1 deletion app/views/plans/_project_details.html.erb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ ethics_report_tooltip = _("Link to a protocol from a meeting with an ethics comm
</div>
<% end %>

<% if Rails.configuration.x.madmp.enable_ethical_issues %>
<% ethical_issues_block = capture do %>
<conditional>
<div class="form-control mb-3">
<div class="col-lg-8">
Expand Down Expand Up @@ -143,6 +143,16 @@ ethics_report_tooltip = _("Link to a protocol from a meeting with an ethics comm
</conditional>
<% end %>

<% if Rails.configuration.x.madmp.enable_ethical_issues %>
Copy link
Contributor

@aaronskiba aaronskiba Oct 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What do you think of the following refactor?

<% if Rails.configuration.x.madmp.enable_ethical_issues && (plan.ethical_issues? || current_user.org.add_ro_ethical_concerns?) %>
  <%= ethical_issues_block %>
<% end %>

<% if plan.ethical_issues == true %>
<%= ethical_issues_block %>
<% else %>
<% if current_user.org.add_ro_ethical_concerns? %>
<%= ethical_issues_block %>
<% end %>
<% end %>
<% end %>

<conditional>
<div id="funder-org-controls" class="form-control mb-3">
<div class="col-lg-8">
Expand Down
6 changes: 6 additions & 0 deletions db/migrate/20251027100520_add_add_ro_ethical_concerns_to_orgs.rb
View file
Open in desktop
Copy link
Contributor

@aaronskiba aaronskiba Oct 24, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It may be best to recreate this migration file (i.e. rails generate migration AddAddRoEthicalConcernsToOrgs) so that it uses the version of Rails that we currently on (i.e. 7.1 rather than 6.1).

Copy link
Contributor Author

@johnpinto1 johnpinto1 Oct 27, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The migration has been re-created for Rails version 7.1 as suggested.

Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
class AddAddRoEthicalConcernsToOrgs < ActiveRecord::Migration[7.1]
def change
add_column :orgs, :add_ro_ethical_concerns, :boolean, default: true, null: false
Org.update_all(add_ro_ethical_concerns: true)
Copy link
Contributor

@aaronskiba aaronskiba Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if Org.update_all(add_ro_ethical_concerns: Rails.configuration.x.madmp.enable_ethical_issues) would be even better.

Also, I am wondering, do we want org admins to be able to set the visibilty of the "Research outputs may have ethical concerns" field regardless of whether Rails.configuration.x.madmp.enable_ethical_issues is set to true or false?

Copy link
Contributor Author

@johnpinto1 johnpinto1 Oct 30, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Worth discussing further at meeting.

end
end
3 changes: 2 additions & 1 deletion db/schema.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
#
# It's strongly recommended that you check this file into your version control system.

ActiveRecord::Schema[7.1].define(version: 2025_01_15_102816) do
ActiveRecord::Schema[7.1].define(version: 2025_10_27_100520) do
# These are extensions that must be enabled in order to support this database
enable_extension "plpgsql"

Expand Down Expand Up @@ -276,6 +276,7 @@
t.string "api_create_plan_email_subject"
t.text "api_create_plan_email_body"
t.string "helpdesk_email"
t.boolean "add_ro_ethical_concerns", default: true, null: false
t.index ["language_id"], name: "fk_rails_5640112cab"
t.index ["region_id"], name: "fk_rails_5a6adf6bab"
end
Expand Down