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
Initial implementation of Overviews::ShowComponent
Alexander Brandon Coles5423f8b33b2a
diff --git a/modules/overviews/app/components/overviews/show_component.html.erb b/modules/overviews/app/components/overviews/show_component.html.erbnew file mode 100644index 00000000000..92f82514d77--- /dev/null+++ b/modules/overviews/app/components/overviews/show_component.html.erb@@ -0,0 +1,79 @@+<%#-- 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.++++#%>++<%=+ if allowed_to_manage?+ 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+%>++<%=+ if sidebar_enabled?+ render(Primer::Alpha::Layout.new) do |component|+ component.with_main do+ angular_component_tag "opce-overview"+ end++ component.with_sidebar(width: :narrow, col_placement: :end) do+ if life_cycle_sidebar_enabled?+ concat(+ render_sidebar_turbo_frame(+ "project-life-cycle-sidebar",+ src: project_life_cycle_sidebar_path(project)+ )+ )+ end++ if custom_fields_sidebar_enabled?+ concat(+ render_sidebar_turbo_frame(+ "project-custom-fields-sidebar",+ src: project_custom_fields_sidebar_path(project)+ )+ )+ end+ end+ end+ else+ angular_component_tag "opce-overview"+ end+%>diff --git a/modules/overviews/app/components/overviews/show_component.rb b/modules/overviews/app/components/overviews/show_component.rbnew file mode 100644index 00000000000..af1794724f5--- /dev/null+++ b/modules/overviews/app/components/overviews/show_component.rb@@ -0,0 +1,76 @@+# frozen_string_literal: true++# -- copyright+# OpenProject is an open source project management software.+# Copyright (C) 2010-2024 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 ShowComponent < ApplicationComponent+ include ApplicationHelper+ include OpPrimer::ComponentHelpers+ include OpTurbo::Streamable+ include AngularHelper+ include Turbo::FramesHelper++ attr_reader :project, :current_user++ def initialize(project:, current_user:)+ super()++ @project = project+ @current_user = current_user+ end++ private++ def allowed_to_manage?+ current_user.allowed_in_project?(:manage_overview, project)+ end++ def sidebar_enabled?+ life_cycle_sidebar_enabled? || custom_fields_sidebar_enabled?+ end++ def life_cycle_sidebar_enabled?+ @life_cycle_sidebar_enabled ||=+ current_user.allowed_in_project?(:view_project_phases, project) &&+ project.phases.active.any?+ end++ def custom_fields_sidebar_enabled?+ @custom_fields_sidebar_enabled ||=+ current_user.allowed_in_project?(:view_project_attributes, project) &&+ project.project_custom_fields.visible.any?+ end++ def render_sidebar_turbo_frame(*ids, src: nil, target: nil, **attributes)+ turbo_frame_tag(*ids, src:, target:, **attributes) do+ image_tag("loading_indicator.svg")+ end+ end+ end+enddiff --git a/modules/overviews/app/controllers/overviews/overviews_controller.rb b/modules/overviews/app/controllers/overviews/overviews_controller.rbindex 7cc6031c82a..bf785b75de9 100644--- a/modules/overviews/app/controllers/overviews/overviews_controller.rb+++ b/modules/overviews/app/controllers/overviews/overviews_controller.rb@@ -31,7 +31,6 @@ module ::Overviewsinclude OpTurbo::ComponentStreambefore_action :jump_to_project_menu_item- before_action :set_sidebar_enabledmenu_item :overview@@ -88,15 +87,6 @@ module ::OverviewsProjectCustomFieldSection.find(params[:section_id])end- def set_sidebar_enabled- @custom_fields_sidebar_enabled =- User.current.allowed_in_project?(:view_project_attributes, @project) &&- @project.project_custom_fields.visible.any?- @life_cycle_sidebar_enabled =- User.current.allowed_in_project?(:view_project_phases, @project) &&- @project.phases.active.any?- end-def handle_errors(project_with_errors, section)update_via_turbo_stream(component: Overviews::ProjectCustomFields::EditComponent.new(diff --git a/modules/overviews/app/views/overviews/overviews/show.html.erb b/modules/overviews/app/views/overviews/overviews/show.html.erbindex 490bb0af7cd..40c8baa9128 100644--- a/modules/overviews/app/views/overviews/overviews/show.html.erb+++ b/modules/overviews/app/views/overviews/overviews/show.html.erb@@ -50,51 +50,4 @@end%>-<%=- 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-%>--<%=- if @custom_fields_sidebar_enabled || @life_cycle_sidebar_enabled- render(Primer::Alpha::Layout.new) do |component|- component.with_main do- angular_component_tag "opce-overview"- end-- component.with_sidebar(width: :narrow, col_placement: :end) do- if @life_cycle_sidebar_enabled- concat(- turbo_frame_tag "project-life-cycle-sidebar", src: project_life_cycle_sidebar_path(@project) do- image_tag("loading_indicator.svg")- end- )- end-- if @custom_fields_sidebar_enabled- concat(- turbo_frame_tag "project-custom-fields-sidebar", src: project_custom_fields_sidebar_path(@project) do- image_tag("loading_indicator.svg")- end- )- end- end- end- else- angular_component_tag "opce-overview"- end-%>+<%= render(Overviews::ShowComponent.new(project: @project, current_user:)) %>diff --git a/modules/overviews/spec/components/overviews/show_component_spec.rb b/modules/overviews/spec/components/overviews/show_component_spec.rbnew file mode 100644index 00000000000..b98e9688ddc--- /dev/null+++ b/modules/overviews/spec/components/overviews/show_component_spec.rb@@ -0,0 +1,159 @@+# 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::ShowComponent, type: :component do+ include Rails.application.routes.url_helpers++ def render_component(...)+ render_inline(described_class.new(...))+ end++ let(:project) { build_stubbed(:project) }+ let(:user) { build_stubbed(:user) }++ current_user { user }++ subject(:rendered_component) do+ render_component(project:, current_user:)+ end++ shared_examples_for "rendering layout with sidebar" do+ it "renders layout" do+ expect(rendered_component).to have_css ".Layout"+ end++ it "renders main" do+ expect(rendered_component).to have_css ".Layout-main"+ end++ it "renders sidebar" do+ expect(rendered_component).to have_css ".Layout-sidebar"+ end+ end++ shared_examples_for "not rendering layout with sidebar" do+ it "does not render layout" do+ expect(rendered_component).to have_no_css ".Layout"+ end++ it "does not render main" do+ expect(rendered_component).to have_no_css ".Layout-main"+ end++ it "does not render sidebar" do+ expect(rendered_component).to have_no_css ".Layout-sidebar"+ end+ end++ it "renders widgets" do+ expect(rendered_component).to have_element "opce-overview"+ end++ context "when user is not allowed to manage" do+ it "does not render '+ Widget' button" do+ expect(rendered_component).to have_no_button "Widget"+ end+ end++ context "when user is allowed to manage" do+ before do+ mock_permissions_for(user) do |mock|+ mock.allow_in_project(:manage_overview, project:)+ end+ end++ it "renders '+ Widget' button" do+ expect(rendered_component).to have_button "Widget" do |button|+ expect(button).to have_octicon :plus+ expect(button["data-action"]).to include "click->overview--add-widgets#addWidget"+ end+ end+ end++ context "when project has neither project attributes or life cycle" do+ it_behaves_like "not rendering layout with sidebar"+ end++ context "when project has project attributes" do+ let(:project) { build(:project) }+ let!(:project_custom_fields) { create_list(:project_custom_field, 2, projects: [project]) }++ context "when user does not have permission to view project attributes" do+ it_behaves_like "not rendering layout with sidebar"++ it "does not render sidebar content in turbo frame" do+ expect(rendered_component).to have_no_element "turbo-frame", id: "project-custom-fields-sidebar"+ end+ end++ context "when user has permission to view project attributes" do+ let(:user) { create(:user, member_with_permissions: { project => [:view_project_attributes] }) }++ it_behaves_like "rendering layout with sidebar"++ it "renders sidebar content in turbo frame" do+ expect(rendered_component).to have_element "turbo-frame",+ id: "project-custom-fields-sidebar",+ src: project_custom_fields_sidebar_path(project)+ end+ end+ end++ context "when project has life cycle" do+ let(:project) { build(:project) }+ let!(:project_phase) { create(:project_phase, project:) }++ context "when user does not have permission to view project life cycle" do+ it_behaves_like "not rendering layout with sidebar"++ it "does not render sidebar content in turbo frame" do+ expect(rendered_component).to have_no_element "turbo-frame", id: "project-life-cycle-sidebar"+ end+ end++ context "when user has permission to view project life cycle" do+ before do+ mock_permissions_for(user) do |mock|+ mock.allow_in_project(:view_project_phases, project:)+ end+ end++ it_behaves_like "rendering layout with sidebar"++ it "renders sidebar content in turbo frame" do+ expect(rendered_component).to have_element "turbo-frame",+ id: "project-life-cycle-sidebar",+ src: project_life_cycle_sidebar_path(project)+ end+ end+ end+end