[#73889] Clean up Backlogs module naming and namespacing by myabc · Pull Request #22829 · opf/openproject

myabc · 2026-04-20T10:12:43Z

Note

This PR is based on #22791. Please review/merge that PR first.

Ticket

https://community.openproject.org/wp/73889

What are you trying to accomplish?

Follow-up to #72661. Finishes the Backlogs naming/namespacing cleanup:

Drops the Redmine-era Rb* / rb_* prefix from the remaining controller and helper.
Moves the remaining Backlogs controllers and helpers under the Backlogs:: module (BacklogsSettingsController → Backlogs::SettingsController, RbCommonHelper → Backlogs::CommonHelper, BurndownChartsHelper → Backlogs::BurndownChartHelper).
Replaces RbApplicationController with Backlogs::BaseController, matching the <Module>::BaseController convention used across Boards, Calendar, TeamPlanner, Gantt, Avatars, etc.
renames agile_sprint_* controller param helpers to sprint_* for consistency
adds a routing spec for /admin/backlogs

Route paths and helper names are unchanged.

What approach did you choose and why?

Four focused commits, each green in isolation. Legacy top-level models (Story, Task, Sprint, Backlog, Burndown) are intentionally left alone — they're removed in OP #71254.

Merge checklist

Added/updated tests

Copilot

Pull request overview

This PR continues the Backlogs module cleanup by aligning naming/namespacing across controllers, helpers, and specs, and by introducing a namespaced admin settings endpoint and view.

Changes:

Rename/namespace Backlogs helpers (RbCommonHelper → Backlogs::CommonHelper, BurndownChartsHelper → Backlogs::BurndownChartHelper) and update consumers/specs.
Introduce Backlogs::BaseController and move Backlogs controllers to inherit from it instead of the legacy RbApplicationController.
Rename the admin settings controller to Backlogs::SettingsController, update its route, and add a new admin settings view.

Reviewed changes

Copilot reviewed 19 out of 20 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
modules/backlogs/spec/views/backlogs/burndown_chart/show_spec.rb	Update view spec to extend the renamed/namespaced burndown chart helper.
modules/backlogs/spec/helpers/backlogs/common_helper_spec.rb	Update helper spec to target `Backlogs::CommonHelper`.
modules/backlogs/spec/controllers/backlogs/settings_controller_spec.rb	Update controller spec to target `Backlogs::SettingsController`.
modules/backlogs/lib/open_project/backlogs/hooks/layout_hook.rb	Update hook to include the renamed/namespaced common helper.
modules/backlogs/config/routes.rb	Point admin backlogs settings route at `backlogs/settings`.
modules/backlogs/app/views/backlogs/settings/show.html.erb	Add admin Backlogs settings page (Primer header + blankslate).
modules/backlogs/app/helpers/backlogs/common_helper.rb	Move common helper into `Backlogs::CommonHelper` namespace.
modules/backlogs/app/helpers/backlogs/burndown_chart_helper.rb	Move burndown helper into `Backlogs::BurndownChartHelper` namespace.
modules/backlogs/app/controllers/backlogs/*.rb	Switch controllers to inherit from `Backlogs::BaseController`; adjust helper loading and controller namespacing.

Copilot

Pull request overview

Copilot reviewed 23 out of 24 changed files in this pull request and generated 2 comments.

Copilot

Pull request overview

Copilot reviewed 23 out of 24 changed files in this pull request and generated 1 comment.

myabc · 2026-04-20T14:20:18Z

+    def format_date_range(dates)
+      return nil if dates.all?(&:nil?)
+
+      from, to = dates.map { |date| tag.time(datetime: date.iso8601) { format_date(date) } if date }
+      safe_join([from, "–", to], " ") # &ndash; and &nbsp;
+    end


(This could also be a View Component) / @HDinger

ulferts

All good

https://community.openproject.org/wp/73889

Matches the `<Module>::BaseController` convention used in `Boards`, `Calendar`, `TeamPlanner`, `Gantt`, and other module engines. https://community.openproject.org/wp/73889

Moves `BacklogsSettingsController` under the `Backlogs::` module as `Backlogs::SettingsController`. Keeps the `admin_backlogs_settings` route name so `redirect_to_backlogs_settings` callers keep working. https://community.openproject.org/wp/73889

https://community.openproject.org/wp/73889

Places the helper next to `format_date` and `format_time` so other modules can reuse it. Adds YARD docs.

Drops the `agile_` prefix from `agile_sprint_params`, `edit_agile_sprint_params`, and `converted_agile_sprint_params`. The controller already sits under `Backlogs::` as `SprintsController`, so the prefix was historical noise from before the namespacing.

The chart payload is serialized with `to_json` at render time, so pre-escaping day labels would (theoretically) add an extra layer of backslashes.

Registers the admin menu entry from OpenProject::Backlogs::Engine and removes the duplicate initializer entry. Adds an engine spec for the admin menu target.

myabc changed the title ~~Code maintenance/73889 backlogs module naming namespacing~~ [#73889] Clean up Backlogs module naming and namespacing Apr 20, 2026

myabc requested a review from Copilot April 20, 2026 10:14

myabc added ruby Pull requests that update Ruby code maintenance labels Apr 20, 2026

myabc added this to the 17.4.x milestone Apr 20, 2026

myabc added the DO NOT MERGE label Apr 20, 2026

Copilot started reviewing on behalf of myabc April 20, 2026 10:15 View session

Copilot AI reviewed Apr 20, 2026

View reviewed changes

Comment thread modules/backlogs/config/routes.rb

Comment thread modules/backlogs/config/routes.rb

myabc force-pushed the code-maintenance/73889-backlogs-module-naming-namespacing branch 2 times, most recently from 93e98ef to c01dfea Compare April 20, 2026 11:05

myabc requested a review from Copilot April 20, 2026 11:09

Copilot AI reviewed Apr 20, 2026

View reviewed changes

Comment thread modules/backlogs/app/helpers/backlogs/burndown_chart_helper.rb Outdated

Comment thread modules/backlogs/lib/open_project/backlogs/hooks/layout_hook.rb Outdated

myabc force-pushed the code-maintenance/73889-backlogs-module-naming-namespacing branch from fc256d7 to 66c0b0c Compare April 20, 2026 11:21

myabc added needs review and removed DO NOT MERGE labels Apr 20, 2026

myabc marked this pull request as ready for review April 20, 2026 11:51

myabc force-pushed the code-maintenance/73889-backlogs-module-naming-namespacing branch from 3ca8292 to 1037de4 Compare April 20, 2026 13:57

myabc force-pushed the code-maintenance/72661-consolidate-backlogs-routes branch from 4436dc7 to d02622e Compare April 20, 2026 13:58

myabc force-pushed the code-maintenance/73889-backlogs-module-naming-namespacing branch from 1037de4 to 34310b4 Compare April 20, 2026 13:59

myabc force-pushed the code-maintenance/72661-consolidate-backlogs-routes branch from d02622e to bb79537 Compare April 20, 2026 14:04

myabc force-pushed the code-maintenance/73889-backlogs-module-naming-namespacing branch from 34310b4 to e42e257 Compare April 20, 2026 14:06

myabc requested review from Copilot and ulferts April 20, 2026 14:09

Copilot started reviewing on behalf of myabc April 20, 2026 14:10 View session

Copilot AI reviewed Apr 20, 2026

View reviewed changes

Comment thread lib_static/redmine/i18n.rb Outdated

myabc commented Apr 20, 2026

View reviewed changes

Comment thread config/initializers/menus.rb Outdated

myabc commented Apr 20, 2026

View reviewed changes

myabc force-pushed the code-maintenance/73889-backlogs-module-naming-namespacing branch from e42e257 to 08f2c88 Compare April 20, 2026 14:37

ulferts approved these changes Apr 20, 2026

View reviewed changes

Comment thread config/initializers/menus.rb Outdated

myabc removed the needs review label Apr 20, 2026

Base automatically changed from code-maintenance/72661-consolidate-backlogs-routes to dev April 20, 2026 15:48

myabc added 10 commits April 20, 2026 17:29

[#73889] Namespace Backlogs::CommonHelper

4f51fb4

https://community.openproject.org/wp/73889

[#73889] Add Backlogs::BaseController

11add38

Matches the `<Module>::BaseController` convention used in `Boards`, `Calendar`, `TeamPlanner`, `Gantt`, and other module engines. https://community.openproject.org/wp/73889

[#73889] Singularize Backlogs::BurndownChartHelper

7f23c97

https://community.openproject.org/wp/73889

Move format_date_range to Redmine::I18n

4295e33

Places the helper next to `format_date` and `format_time` so other modules can reuse it. Adds YARD docs.

Add routing spec for admin Backlogs settings

deb656f

Rename sprint param helpers

f80f8a3

Drops the `agile_` prefix from `agile_sprint_params`, `edit_agile_sprint_params`, and `converted_agile_sprint_params`. The controller already sits under `Backlogs::` as `SprintsController`, so the prefix was historical noise from before the namespacing.

Remove extraneous burndown label escaping

d2ed42e

The chart payload is serialized with `to_json` at render time, so pre-escaping day labels would (theoretically) add an extra layer of backslashes.

Move admin Backlogs menu to engine

ce1b103

Registers the admin menu entry from OpenProject::Backlogs::Engine and removes the duplicate initializer entry. Adds an engine spec for the admin menu target.

Fix missing Backlogs menu on Burndown Chart page

031d9f3

myabc force-pushed the code-maintenance/73889-backlogs-module-naming-namespacing branch from 0b1c77e to 031d9f3 Compare April 20, 2026 16:29

myabc merged commit ba41c89 into dev Apr 20, 2026
16 of 17 checks passed

myabc deleted the code-maintenance/73889-backlogs-module-naming-namespacing branch April 20, 2026 16:54

github-actions Bot locked and limited conversation to collaborators Apr 20, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[#73889] Clean up Backlogs module naming and namespacing#22829

[#73889] Clean up Backlogs module naming and namespacing#22829
myabc merged 10 commits intodevfrom
code-maintenance/73889-backlogs-module-naming-namespacing

myabc commented Apr 20, 2026 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

myabc Apr 20, 2026

Uh oh!

ulferts left a comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

Conversation

myabc commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Ticket

What are you trying to accomplish?

What approach did you choose and why?

Merge checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Uh oh!

Uh oh!

myabc Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

ulferts left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

3 participants

myabc commented Apr 20, 2026 •

edited

Loading