OpenProject is the leading open source project management software for product, project and portfolio management. A powerful Jira alternative with agile planning, issue tracking, roadmaps, Gantt charts, time tracking, collaboration features, and more. Available on premises or in the cloud. ⭐ Star us on GitHub
Ruby agile-developmentangularbcfboardsbug-trackerganttgantt-chartifcissue-trackerjira-alternativekanbanopenprojectproduct-managementproject-managementproject-planningroadmaprubyscrumtimelineworkflows
Split up overview and dashboard page
Oliver Günther8cffb95f4f55
diff --git a/app/models/project.rb b/app/models/project.rbindex e033cba919e..339d9a3bd05 100644--- a/app/models/project.rb+++ b/app/models/project.rb@@ -259,6 +259,17 @@ class Project < ApplicationRecordnameend+ def workspace_label+ case workspace_type+ when "program"+ I18n.t("label_program")+ when "portfolio"+ I18n.t("label_portfolio")+ else+ I18n.t("label_project")+ end+ end+# Return true if this project is allowed to do the specified action.# action can be:# * a parameter-like Hash (eg. controller: '/projects', action: 'edit')diff --git a/frontend/src/app/app.module.ts b/frontend/src/app/app.module.tsindex 76bc3461a30..4442ec37426 100644--- a/frontend/src/app/app.module.ts+++ b/frontend/src/app/app.module.ts@@ -208,7 +208,7 @@ import {import { OpInviteUserModalAugmentService } from 'core-app/features/invite-user-modal/invite-user-modal-augment.service';import { TimeEntryTimerService } from 'core-app/shared/components/time_entries/services/time-entry-timer.service';import { MyPageComponent } from './features/my-page/my-page.component';-import { OverviewComponent } from './features/overview/overview.component';+import { DashboardComponent } from './features/overview/dashboard.component';export function initializeServices(injector:Injector) {return () => {@@ -427,6 +427,6 @@ export class OpenProjectModule implements DoBootstrap {registerCustomElement('opce-colors-autocompleter', ColorsAutocompleterComponent, { injector });registerCustomElement('opce-my-page', MyPageComponent, { injector });- registerCustomElement('opce-overview', OverviewComponent, { injector });+ registerCustomElement('opce-dashboard', DashboardComponent, { injector });}}diff --git a/frontend/src/app/features/overview/overview.component.ts b/frontend/src/app/features/overview/dashboard.component.tssimilarity index 91%rename from frontend/src/app/features/overview/overview.component.tsrename to frontend/src/app/features/overview/dashboard.component.tsindex 05917e40d04..811938e3f6d 100644--- a/frontend/src/app/features/overview/overview.component.ts+++ b/frontend/src/app/features/overview/dashboard.component.ts@@ -31,15 +31,15 @@ import { GridPageComponent } from 'core-app/shared/components/grids/grid/page/grimport { GRID_PROVIDERS } from 'core-app/shared/components/grids/grid/grid.component';@Component({- selector: 'overview',+ selector: 'dashboard',changeDetection: ChangeDetectionStrategy.OnPush,templateUrl: '../../shared/components/grids/grid/page/grid-page.component.html',styleUrls: ['../../shared/components/grids/grid/page/grid-page.component.sass'],providers: GRID_PROVIDERS,standalone: false,})-export class OverviewComponent extends GridPageComponent {+export class DashboardComponent extends GridPageComponent {protected gridScopePath():string {- return this.pathHelper.projectPath(this.currentProject.identifier ?? '');+ return this.pathHelper.projectDashboardsPath(this.currentProject.identifier ?? '');}}diff --git a/frontend/src/app/features/overview/openproject-overview.module.ts b/frontend/src/app/features/overview/openproject-overview.module.tsindex 2af5a8d3705..3813a1a0c79 100644--- a/frontend/src/app/features/overview/openproject-overview.module.ts+++ b/frontend/src/app/features/overview/openproject-overview.module.ts@@ -29,7 +29,7 @@import { NgModule } from '@angular/core';import { OpSharedModule } from 'core-app/shared/shared.module';import { OpenprojectGridsModule } from 'core-app/shared/components/grids/openproject-grids.module';-import { OverviewComponent } from 'core-app/features/overview/overview.component';+import { DashboardComponent } from 'core-app/features/overview/dashboard.component';@NgModule({imports: [@@ -40,7 +40,7 @@ import { OverviewComponent } from 'core-app/features/overview/overview.componentproviders: [],declarations: [- OverviewComponent,+ DashboardComponent,],})export class OpenprojectOverviewModule {} // eslint-disable-line @typescript-eslint/no-extraneous-classdiff --git a/modules/overviews/app/components/overviews/project_custom_fields/side_panel_component.rb b/modules/overviews/app/components/overviews/project_custom_fields/side_panel_component.rbindex 2f531e43142..b5b06430851 100644--- a/modules/overviews/app/components/overviews/project_custom_fields/side_panel_component.rb+++ b/modules/overviews/app/components/overviews/project_custom_fields/side_panel_component.rb@@ -41,6 +41,11 @@ module Overviews@project = projectend+ def render?+ User.current.allowed_in_project?(:view_project_attributes, @project) &&+ @project.project_custom_fields.visible.any?+ end+privatedef available_project_custom_fields_grouped_by_sectiondiff --git a/modules/overviews/app/components/overviews/project_phases/side_panel_component.rb b/modules/overviews/app/components/overviews/project_phases/side_panel_component.rbindex 4929ccba078..f85d6d227f9 100644--- a/modules/overviews/app/components/overviews/project_phases/side_panel_component.rb+++ b/modules/overviews/app/components/overviews/project_phases/side_panel_component.rb@@ -40,6 +40,11 @@ module Overviews@project = projectend++ def render?+ User.current.allowed_in_project?(:view_project_phases, @project) &&+ @project.phases.active.any?+ endendendenddiff --git a/modules/overviews/app/components/overviews/show_component.html.erb b/modules/overviews/app/components/overviews/show_component.html.erbindex fc4c5840c3b..1c5c6b894e6 100644--- a/modules/overviews/app/components/overviews/show_component.html.erb+++ b/modules/overviews/app/components/overviews/show_component.html.erb@@ -73,6 +73,6 @@ See COPYRIGHT and LICENSE files for more details.)end- concat(angular_component_tag("opce-overview"))+ concat(angular_component_tag("opce-dashboard"))end%>diff --git a/modules/overviews/app/components/overviews/side_panel_component.html.erb b/modules/overviews/app/components/overviews/side_panel_component.html.erbnew file mode 100644index 00000000000..6987c74be05--- /dev/null+++ b/modules/overviews/app/components/overviews/side_panel_component.html.erb@@ -0,0 +1,12 @@+<%=+ component_wrapper do+ render(Primer::OpenProject::SidePanel.new(spacious: true)) do |panel|+ [+ Overviews::ProjectCustomFields::SidePanelComponent.new(project: @project),+ Overviews::ProjectPhases::SidePanelComponent.new(project: @project)+ ].each do |component|+ panel.with_section(component)+ end+ end+ end+%>diff --git a/modules/overviews/app/components/overviews/side_panel_component.rb b/modules/overviews/app/components/overviews/side_panel_component.rbnew file mode 100644index 00000000000..7dc411f0f09--- /dev/null+++ b/modules/overviews/app/components/overviews/side_panel_component.rb@@ -0,0 +1,43 @@+# 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 Overviews+ class SidePanelComponent < ApplicationComponent+ include ApplicationHelper+ include OpTurbo::Streamable+ include OpPrimer::ComponentHelpers++ def initialize(project:)+ super()++ @project = project+ end+ end+enddiff --git a/modules/overviews/app/views/overviews/overviews/_page_header.html.erb b/modules/overviews/app/views/overviews/overviews/_page_header.html.erbnew file mode 100644index 00000000000..30cda74a2d5--- /dev/null+++ b/modules/overviews/app/views/overviews/overviews/_page_header.html.erb@@ -0,0 +1,71 @@+<%=+ render(Primer::OpenProject::PageHeader.new) do |header|+ header.with_title(variant: :medium) { t("overviews.label") }+ header.with_breadcrumbs(+ [+ { href: project_path(@project), text: @project.name, skip_for_mobile: true },+ t("overviews.label")+ ]+ )+ favored = @project.favored_by?(User.current)+ header.with_action_icon_button(+ icon: favored ? "star-fill" : "star",+ mobile_icon: favored ? "star-fill" : "star",+ size: :medium,+ tag: :a,+ href: build_favorite_path(@project, format: :html),+ data: { method: favored ? :delete : :post },+ classes: favored ? "op-primer--star-icon" : "",+ label: favored ? I18n.t(:button_unfavorite) : I18n.t(:button_favorite),+ aria: { label: favored ? I18n.t(:button_unfavorite) : I18n.t(:button_favorite) },+ test_selector: "project-favorite-button"+ )++ header.with_action_menu(+ menu_arguments: { anchor_align: :end },+ button_arguments: { icon: "kebab-horizontal", "aria-label": t(:label_menu) }+ ) do |menu|+ if User.current.allowed_in_project?(:select_project_custom_fields, @project)+ menu.with_item(+ label: t(:label_project_attribute_manage_link),+ href: project_settings_project_custom_fields_path(@project),+ data: { turbo: false }+ ) do |item|+ item.with_leading_visual_icon(icon: :pencil)+ end+ end++ if User.current.allowed_in_project?(:archive_project, @project)+ menu.with_item(+ label: t(:label_archive_project),+ href: project_archive_path(@project, status: "", name: @project.name),+ content_arguments: {+ data: { method: :post, turbo: false, confirm: t("project.archive.are_you_sure", name: @project.name) }+ }+ ) do |item|+ item.with_leading_visual_icon(icon: :lock)+ end+ end+ end++ header.with_tab_nav(label: nil, test_selector: "overview-tabs") do |tab_nav|+ tab_nav.with_tab(+ test_selector: "project-overview-tab",+ selected: current_page?(project_overview_path),+ href: project_overview_path,+ ) do |t|+ t.with_icon(icon: :"op-view-split")+ t.with_text { I18n.t("overviews.label_overview") }+ end++ tab_nav.with_tab(+ test_selector: "project-dashboard-tab",+ selected: current_page?(dashboard_project_overview_path),+ href: dashboard_project_overview_path,+ ) do |t|+ t.with_icon(icon: :"op-view-list")+ t.with_text { I18n.t("overviews.label_dashboard") }+ end+ end+ end+%>diff --git a/modules/overviews/app/views/overviews/overviews/dashboard.html.erb b/modules/overviews/app/views/overviews/overviews/dashboard.html.erbnew file mode 100644index 00000000000..c10246449da--- /dev/null+++ b/modules/overviews/app/views/overviews/overviews/dashboard.html.erb@@ -0,0 +1,22 @@+<%= render partial: "page_header" %>++<%=+ if User.current.allowed_in_project?(:manage_overview, @project)+ render(Primer::OpenProject::SubHeader.new) do |subheader|+ subheader.with_action_button(+ scheme: :primary,+ leading_icon: :plus,+ label: t(:label_widget_new),+ data: {+ controller: "overview--add-widgets",+ action: "click->overview--add-widgets#addWidget"+ },+ test_selector: "overview--add-widgets-button"+ ) do+ t(:label_widget)+ end+ end+ end+%>++<%= angular_component_tag "opce-dashboard" %>diff --git a/modules/overviews/config/locales/en.yml b/modules/overviews/config/locales/en.ymlindex a58c4598844..91e68918729 100644--- a/modules/overviews/config/locales/en.yml+++ b/modules/overviews/config/locales/en.yml@@ -1,4 +1,6 @@en:overviews:- label: 'Overview'+ label_home: "%{workspace_type} home"+ label_dashboard: "Dashboard"+ label_overview: 'Overview'permission_manage_overview: 'Manage overview page'diff --git a/modules/overviews/config/routes.rb b/modules/overviews/config/routes.rbindex a519839a7e8..02ba96b0b74 100644--- a/modules/overviews/config/routes.rb+++ b/modules/overviews/config/routes.rb@@ -4,7 +4,9 @@ Rails.application.routes.draw doconstraints(project_id: Regexp.new("(?!(#{Project::RESERVED_IDENTIFIERS.join('|')})$)(\\w|-)+"), format: :html) doscope "projects/:project_id", as: "project" doscope module: "overviews" do- resource :overview, path: "/", only: [:show]+ resource :overview, path: "/", only: [:show] do+ get :dashboard, on: :member+ endcontroller :overviews doget "project_custom_fields_sidebar" => :project_custom_fields_sidebar, as: :custom_fields_sidebardiff --git a/modules/overviews/lib/overviews/engine.rb b/modules/overviews/lib/overviews/engine.rbindex 6d40231fc56..76e22ac23c2 100644--- a/modules/overviews/lib/overviews/engine.rb+++ b/modules/overviews/lib/overviews/engine.rb@@ -36,7 +36,7 @@ module Overviews::Redmine::MenuManager.map(:project_menu) do |menu|menu.push(:overview,{ controller: "/overviews/overviews", action: "show" },- caption: :"overviews.label",+ caption: ->(project) { I18n.t("overviews.label_home", workspace_type: project.workspace_label) },first: true,icon: "info")end@@ -48,6 +48,7 @@ module Overviews.controller_actions.push("overviews/overviews/show",+ "overviews/overviews/dashboard","overviews/widgets/project_statuses/show")diff --git a/modules/overviews/spec/components/overviews/show_component_spec.rb b/modules/overviews/spec/components/overviews/show_component_spec.rbindex 910f0bf4f50..b91a5face15 100644--- a/modules/overviews/spec/components/overviews/show_component_spec.rb+++ b/modules/overviews/spec/components/overviews/show_component_spec.rb@@ -75,7 +75,7 @@ RSpec.describe Overviews::ShowComponent, type: :component doendit "renders widgets" do- expect(rendered_component).to have_element "opce-overview"+ expect(rendered_component).to have_element "opce-dashboard"endcontext "when user is not allowed to manage" dodiff --git a/modules/overviews/spec/routing/overviews_routing_spec.rb b/modules/overviews/spec/routing/overviews_routing_spec.rbindex d8173ba35d5..0dfb10b12d7 100644--- a/modules/overviews/spec/routing/overviews_routing_spec.rb+++ b/modules/overviews/spec/routing/overviews_routing_spec.rb@@ -39,6 +39,13 @@ RSpec.describe Overviews::OverviewsController do)end+ it do+ expect(get("/projects/my-project/dashboard"))+ .to route_to(+ controller: "overviews/overviews", action: "dashboard", project_id: "my-project"+ )+ end+it doexpect(get("/projects/my-project/project_custom_fields_sidebar")).to route_to(@@ -64,6 +71,13 @@ RSpec.describe Overviews::OverviewsController do)end+ it do+ expect(get(dashboard_project_overview_path("my-project")))+ .to route_to(+ controller: "overviews/overviews", action: "dashboard", project_id: "my-project"+ )+ end+it doexpect(get(project_custom_fields_sidebar_path("my-project"))).to route_to(