Skip to content

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

Implement initial Overviews::PageHeaderComponent

Alexander Brandon Coles15f1d03418e3
diff --git a/modules/overviews/app/views/overviews/overviews/_page_header.html.erb b/modules/overviews/app/components/overviews/page_header_component.html.erb
similarity index 54%
rename from modules/overviews/app/views/overviews/overviews/_page_header.html.erb
rename to modules/overviews/app/components/overviews/page_header_component.html.erb
index 463072e7b6f..326e192866f 100644
--- a/modules/overviews/app/views/overviews/overviews/_page_header.html.erb
+++ b/modules/overviews/app/components/overviews/page_header_component.html.erb
@@ -1,23 +1,18 @@
<%=
render(Primer::OpenProject::PageHeader.new) do |header|
- header.with_title(variant: :medium) { I18n.t("overviews.label_home", workspace_type: @project.workspace_label) }
- header.with_breadcrumbs(
- [
- { href: project_path(@project), text: @project.name, skip_for_mobile: true },
- I18n.t("overviews.label_home", workspace_type: @project.workspace_label)
- ]
- )
- favored = @project.favored_by?(User.current)
+ header.with_title(variant: :medium) { page_title }
+ header.with_breadcrumbs(breadcrumb_items)
+
header.with_action_icon_button(
- icon: favored ? "star-fill" : "star",
- mobile_icon: favored ? "star-fill" : "star",
+ icon: favorited? ? "star-fill" : "star",
+ mobile_icon: favorited? ? "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) },
+ href: helpers.build_favorite_path(project, format: :html),
+ data: { method: favorited? ? :delete : :post },
+ classes: favorited? ? "op-primer--star-icon" : "",
+ label: favorited? ? I18n.t(:button_unfavorite) : I18n.t(:button_favorite),
+ aria: { label: favorited? ? I18n.t(:button_unfavorite) : I18n.t(:button_favorite) },
test_selector: "project-favorite-button"
)
@@ -25,22 +20,22 @@
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)
+ if allowed_to_select_project_custom_fields?
menu.with_item(
label: t(:label_project_attribute_manage_link),
- href: project_settings_project_custom_fields_path(@project),
+ href: helpers.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)
+ if allowed_to_archive?
menu.with_item(
label: t(:label_archive_project),
- href: project_archive_path(@project, status: "", name: @project.name),
+ href: helpers.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) }
+ data: { method: :post, turbo: false, confirm: t("project.archive.are_you_sure", name: project.name) }
}
) do |item|
item.with_leading_visual_icon(icon: :lock)
@@ -52,7 +47,7 @@
tab_nav.with_tab(
test_selector: "project-overview-tab",
selected: current_page?(project_overview_path),
- href: project_overview_path,
+ href: helpers.project_overview_path,
) do |t|
t.with_icon(icon: :"op-view-split")
t.with_text { I18n.t("overviews.label_overview") }
@@ -61,7 +56,7 @@
tab_nav.with_tab(
test_selector: "project-dashboard-tab",
selected: current_page?(dashboard_project_overview_path),
- href: dashboard_project_overview_path,
+ href: helpers.dashboard_project_overview_path,
) do |t|
t.with_icon(icon: :"op-view-list")
t.with_text { I18n.t("overviews.label_dashboard") }
diff --git a/modules/overviews/app/components/overviews/page_header_component.rb b/modules/overviews/app/components/overviews/page_header_component.rb
new file mode 100644
index 00000000000..b2aac2d2a62
--- /dev/null
+++ b/modules/overviews/app/components/overviews/page_header_component.rb
@@ -0,0 +1,66 @@
+# 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 PageHeaderComponent < ApplicationComponent
+ extend Dry::Initializer
+
+ include ApplicationHelper
+ include Redmine::I18n
+
+ option :project
+ option :current_user, default: -> { User.current }
+
+ private
+
+ def breadcrumb_items
+ [
+ { href: project_path(project), text: project.name, skip_for_mobile: true },
+ page_title
+ ]
+ end
+
+ def page_title
+ I18n.t("overviews.label_home", workspace_type: project.workspace_label)
+ end
+
+ def favorited?
+ project.favored_by?(current_user)
+ end
+
+ def allowed_to_select_project_custom_fields?
+ current_user.allowed_in_project?(:select_project_custom_fields, project)
+ end
+
+ def allowed_to_archive?
+ current_user.allowed_in_project?(:archive_project, project)
+ end
+ end
+end
diff --git a/modules/overviews/app/views/overviews/overviews/dashboard.html.erb b/modules/overviews/app/views/overviews/overviews/dashboard.html.erb
index 7171009d1d9..8fc7d192514 100644
--- a/modules/overviews/app/views/overviews/overviews/dashboard.html.erb
+++ b/modules/overviews/app/views/overviews/overviews/dashboard.html.erb
@@ -1,2 +1,2 @@
-<%= render partial: "page_header" %>
+<%= render(Overviews::PageHeaderComponent.new(project: @project, current_user:)) %>
<%= render(Overviews::DashboardComponent.new(project: @project, current_user:)) %>
diff --git a/modules/overviews/app/views/overviews/overviews/show.html.erb b/modules/overviews/app/views/overviews/overviews/show.html.erb
index 51441e15064..2789b680bd3 100644
--- a/modules/overviews/app/views/overviews/overviews/show.html.erb
+++ b/modules/overviews/app/views/overviews/overviews/show.html.erb
@@ -1,2 +1,2 @@
-<%= render partial: "page_header" %>
+<%= render(Overviews::PageHeaderComponent.new(project: @project, current_user:)) %>
<%= render(Overviews::ShowComponent.new(project: @project, current_user:)) %>
diff --git a/modules/overviews/spec/components/overviews/page_header_component_spec.rb b/modules/overviews/spec/components/overviews/page_header_component_spec.rb
new file mode 100644
index 00000000000..affcd6f796e
--- /dev/null
+++ b/modules/overviews/spec/components/overviews/page_header_component_spec.rb
@@ -0,0 +1,168 @@
+# 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 Overviews::PageHeaderComponent, type: :component do
+ def render_component(...)
+ render_inline(described_class.new(...))
+ end
+
+ let(:workspace_type) { :project }
+ let(:project) { build_stubbed(:project, name: "Too big to fail", workspace_type:) }
+ let(:user) { build_stubbed(:user) }
+
+ current_user { user }
+
+ subject(:rendered_component) do
+ with_controller_class(Overviews::OverviewsController) do
+ with_request_url("/projects/identifier") do
+ render_component(project:, current_user:)
+ end
+ end
+ end
+
+ shared_examples_for "rendering breadcrumbs" do |breadcrumbs|
+ it "renders #{breadcrumbs.size} breadcrumbs", :aggregate_failures do
+ expect(rendered_component).to have_navigation "Breadcrumb", class: "PageHeader-breadcrumbs" do |nav|
+ expect(nav).to have_list_item count: breadcrumbs.size
+ breadcrumbs.each.with_index do |breadcrumb, i|
+ expect(nav).to have_list_item position: i + 1, text: breadcrumb
+ end
+ end
+ end
+ end
+
+ describe "context bar" do
+ it "renders context bar" do
+ expect(rendered_component).to have_css ".PageHeader-contextBar"
+ end
+
+ it "renders current page" do
+ expect(rendered_component).to have_link "Project home", current: "page"
+ end
+ end
+
+ it "renders a Page Header (with tab nav)" do
+ expect(rendered_component).to have_element "page-header", class: "PageHeader--withTabNav"
+ end
+
+ context "with Project" do
+ it "renders title" do
+ expect(rendered_component).to have_heading "Project home", class: "PageHeader-title"
+ end
+
+ it_behaves_like "rendering breadcrumbs", ["OpenProject", "Too big to fail", "Project home"]
+ end
+
+ context "with Portfolio" do
+ let(:workspace_type) { :portfolio }
+
+ it "renders title" do
+ expect(rendered_component).to have_heading "Portfolio home", class: "PageHeader-title"
+ end
+
+ it_behaves_like "rendering breadcrumbs", ["OpenProject", "Too big to fail", "Portfolio home"]
+ end
+
+ context "with Program" do
+ let(:workspace_type) { :program }
+
+ it "renders title" do
+ expect(rendered_component).to have_heading "Program home", class: "PageHeader-title"
+ end
+
+ it_behaves_like "rendering breadcrumbs", ["OpenProject", "Too big to fail", "Program home"]
+ end
+
+ describe "actions" do
+ it "renders actions" do
+ expect(rendered_component).to have_css ".PageHeader-actions"
+ end
+
+ it "renders favorite button" do
+ expect(rendered_component).to have_link class: "PageHeader-action" do |link|
+ expect(link).to have_octicon :star
+ end
+ end
+
+ it "renders a Primer ActionMenu (single variant)" do
+ expect(rendered_component).to have_element "action-menu", "data-select-variant": "none"
+ end
+
+ context "without manage permissions" do
+ it "renders action menu items", :aggregate_failures do
+ expect(rendered_component).to have_menu do |menu|
+ expect(menu).to have_selector :menuitem, count: 1
+ expect(menu).to have_selector :menuitem, text: "Add to favorites"
+ end
+ end
+ end
+
+ context "with manage permissions" do
+ let(:user) { build_stubbed(:admin) }
+
+ it "renders action menu items", :aggregate_failures do
+ expect(rendered_component).to have_menu do |menu|
+ expect(menu).to have_selector :menuitem, count: 3
+ expect(menu).to have_selector :menuitem, text: "Add to favorites"
+ expect(menu).to have_selector :menuitem, text: "Manage project attributes"
+ expect(menu).to have_selector :menuitem, text: "Archive project"
+ end
+ end
+ end
+ end
+
+ describe "tab bar" do
+ it "renders a tab bar" do
+ expect(rendered_component).to have_css ".PageHeader-tabNavBar"
+ end
+
+ it "renders 2 tabs", :aggregate_failures do
+ expect(rendered_component).to have_list class: "tabnav-tabs" do |list|
+ expect(list).to have_list_item count: 2
+ expect(list).to have_list_item "Overview"
+ expect(list).to have_list_item "Dashboard"
+ end
+ end
+
+ it "renders Overview tab link", :aggregate_failures do
+ expect(rendered_component).to have_link "Overview" do |link|
+ expect(link).to have_octicon :"op-view-split"
+ end
+ end
+
+ it "renders Dashboard tab link", :aggregate_failures do
+ expect(rendered_component).to have_link "Dashboard" do |link|
+ expect(link).to have_octicon :"op-view-list"
+ end
+ end
+ end
+end