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

Move News (BETA) widget to Grids module

Alexander Brandon Coles586106dc6729
diff --git a/frontend/src/app/shared/components/grids/widgets/news-beta/news-beta.component.ts b/frontend/src/app/shared/components/grids/widgets/news-beta/news-beta.component.ts
index 294ba9d5218..a7cdd4ddcfd 100644
--- a/frontend/src/app/shared/components/grids/widgets/news-beta/news-beta.component.ts
+++ b/frontend/src/app/shared/components/grids/widgets/news-beta/news-beta.component.ts
@@ -35,6 +35,6 @@ import { AbstractTurboWidgetComponent } from 'core-app/shared/components/grids/w
standalone: false,
})
export class WidgetNewsBetaComponent extends AbstractTurboWidgetComponent {
- override frameId = 'overviews-widgets-news-component';
+ override frameId = 'grids-widgets-news-component';
override name = 'news';
}
diff --git a/modules/overviews/app/components/overviews/widgets/news_component.html.erb b/modules/grids/app/components/grids/widgets/news_component.html.erb
similarity index 100%
rename from modules/overviews/app/components/overviews/widgets/news_component.html.erb
rename to modules/grids/app/components/grids/widgets/news_component.html.erb
diff --git a/modules/overviews/app/components/overviews/widgets/news_component.rb b/modules/grids/app/components/grids/widgets/news_component.rb
similarity index 99%
rename from modules/overviews/app/components/overviews/widgets/news_component.rb
rename to modules/grids/app/components/grids/widgets/news_component.rb
index 060f7960b47..8b0529fb3bb 100644
--- a/modules/overviews/app/components/overviews/widgets/news_component.rb
+++ b/modules/grids/app/components/grids/widgets/news_component.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-module Overviews
+module Grids
module Widgets
class NewsComponent < ApplicationComponent
NEWS_LIMIT = 5
diff --git a/modules/overviews/app/controllers/overviews/project_widget_controller.rb b/modules/grids/app/controllers/grids/widget_controller.rb
similarity index 94%
rename from modules/overviews/app/controllers/overviews/project_widget_controller.rb
rename to modules/grids/app/controllers/grids/widget_controller.rb
index 184306c5aa1..d64bbd97f99 100644
--- a/modules/overviews/app/controllers/overviews/project_widget_controller.rb
+++ b/modules/grids/app/controllers/grids/widget_controller.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-class Overviews::ProjectWidgetController < Grids::BaseInProjectController
+class Grids::WidgetController < Grids::BaseInOptionalProjectController
include OpTurbo::ComponentStream
include OpTurbo::FlashStreamHelper
diff --git a/modules/overviews/app/controllers/overviews/widgets/news_controller.rb b/modules/grids/app/controllers/grids/widgets/news_controller.rb
similarity index 94%
rename from modules/overviews/app/controllers/overviews/widgets/news_controller.rb
rename to modules/grids/app/controllers/grids/widgets/news_controller.rb
index d64f9cfe9f7..8ba1027006d 100644
--- a/modules/overviews/app/controllers/overviews/widgets/news_controller.rb
+++ b/modules/grids/app/controllers/grids/widgets/news_controller.rb
@@ -28,5 +28,5 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-class Overviews::Widgets::NewsController < Overviews::WidgetController
+class Grids::Widgets::NewsController < Grids::WidgetController
end
diff --git a/modules/overviews/app/views/overviews/widgets/news/show.html.erb b/modules/grids/app/views/grids/widgets/news/show.html.erb
similarity index 93%
rename from modules/overviews/app/views/overviews/widgets/news/show.html.erb
rename to modules/grids/app/views/grids/widgets/news/show.html.erb
index 5896eba57f8..f308a9bf7a8 100644
--- a/modules/overviews/app/views/overviews/widgets/news/show.html.erb
+++ b/modules/grids/app/views/grids/widgets/news/show.html.erb
@@ -27,4 +27,4 @@ See COPYRIGHT and LICENSE files for more details.
++#%>
-<%= render Overviews::Widgets::NewsComponent.new(project: @project, current_user:) %>
+<%= render Grids::Widgets::NewsComponent.new(project: @project, current_user:) %>
diff --git a/modules/grids/config/routes.rb b/modules/grids/config/routes.rb
new file mode 100644
index 00000000000..0e89e330574
--- /dev/null
+++ b/modules/grids/config/routes.rb
@@ -0,0 +1,47 @@
+# 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.
+#++
+
+Rails.application.routes.draw do
+ constraints(project_id: Regexp.new("(?!(#{Project::RESERVED_IDENTIFIERS.join('|')})$)(\\w|-)+"), format: :html) do
+ scope "projects/:project_id", as: "project" do
+ scope module: "grids" do
+ namespace :widgets do
+ resource :news, only: %i[show]
+ end
+ end
+ end
+ end
+
+ scope module: "grids" do
+ namespace :widgets do
+ resource :news, only: %i[show]
+ end
+ end
+end
diff --git a/modules/grids/lib/grids/engine.rb b/modules/grids/lib/grids/engine.rb
index 3d4a4c6a327..763cd34dec3 100644
--- a/modules/grids/lib/grids/engine.rb
+++ b/modules/grids/lib/grids/engine.rb
@@ -1,11 +1,23 @@
module Grids
class Engine < ::Rails::Engine
+ engine_name :grids
+
include OpenProject::Plugins::ActsAsOpEngine
add_api_path :attachments_by_grid do |id|
"#{root}/grids/#{id}/attachments"
end
+ initializer "grids.permissions" do
+ Rails.application.reloader.to_prepare do
+ OpenProject::AccessControl.permission(:view_news)
+ .controller_actions
+ .push(
+ "grids/widgets/news/show"
+ )
+ end
+ end
+
config.to_prepare do
Queries::Register.register(Grids::Query) do
filter Grids::Filters::ScopeFilter
diff --git a/modules/overviews/spec/components/overviews/widgets/news_component_spec.rb b/modules/grids/spec/components/grids/widgets/news_component_spec.rb
similarity index 97%
rename from modules/overviews/spec/components/overviews/widgets/news_component_spec.rb
rename to modules/grids/spec/components/grids/widgets/news_component_spec.rb
index a10f168a4d6..0487b1c1c27 100644
--- a/modules/overviews/spec/components/overviews/widgets/news_component_spec.rb
+++ b/modules/grids/spec/components/grids/widgets/news_component_spec.rb
@@ -30,7 +30,7 @@
require "rails_helper"
-RSpec.describe Overviews::Widgets::NewsComponent, type: :component do
+RSpec.describe Grids::Widgets::NewsComponent, type: :component do
include Rails.application.routes.url_helpers
def render_component(...)
diff --git a/modules/overviews/spec/controllers/overviews/widgets/news_controller_spec.rb b/modules/grids/spec/controllers/grids/widgets/news_controller_spec.rb
similarity index 96%
rename from modules/overviews/spec/controllers/overviews/widgets/news_controller_spec.rb
rename to modules/grids/spec/controllers/grids/widgets/news_controller_spec.rb
index 051d3363571..369462271b1 100644
--- a/modules/overviews/spec/controllers/overviews/widgets/news_controller_spec.rb
+++ b/modules/grids/spec/controllers/grids/widgets/news_controller_spec.rb
@@ -30,7 +30,7 @@
require "rails_helper"
-RSpec.describe Overviews::Widgets::NewsController do
+RSpec.describe Grids::Widgets::NewsController do
shared_let(:project) { create(:project) }
shared_let(:user) { create(:user, member_with_permissions: { project => %i[view_news] }) }
current_user { user }
diff --git a/modules/overviews/spec/permissions/widgets/news_spec.rb b/modules/grids/spec/permissions/widgets/news_spec.rb
similarity index 85%
rename from modules/overviews/spec/permissions/widgets/news_spec.rb
rename to modules/grids/spec/permissions/widgets/news_spec.rb
index 353f71486ad..bc5faa44950 100644
--- a/modules/overviews/spec/permissions/widgets/news_spec.rb
+++ b/modules/grids/spec/permissions/widgets/news_spec.rb
@@ -31,8 +31,8 @@
require "spec_helper"
require "support/permission_specs"
-RSpec.describe Overviews::Widgets::NewsController, "permissions", type: :controller do # rubocop:disable RSpec/EmptyExampleGroup,RSpec/SpecFilePathFormat
+RSpec.describe Grids::Widgets::NewsController, "permissions", type: :controller do # rubocop:disable RSpec/EmptyExampleGroup,RSpec/SpecFilePathFormat
include PermissionSpecs
- check_permission_required_for("overviews/widgets/news#show", :view_project)
+ check_permission_required_for("grids/widgets/news#show", :view_news)
end
diff --git a/modules/grids/spec/routing/widget_routing_spec.rb b/modules/grids/spec/routing/widget_routing_spec.rb
new file mode 100644
index 00000000000..bd3ac6ed5cc
--- /dev/null
+++ b/modules/grids/spec/routing/widget_routing_spec.rb
@@ -0,0 +1,69 @@
+# 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 Grids::WidgetController do
+ describe "news routing" do
+ describe "GET #show" do
+ context "for root" do
+ it do
+ expect(get("/widgets/news"))
+ .to route_to(controller: "grids/widgets/news", action: "show")
+ end
+ end
+
+ context "with project" do
+ it do
+ expect(get("/projects/my-project/widgets/news"))
+ .to route_to(controller: "grids/widgets/news", action: "show", project_id: "my-project")
+ end
+ end
+ end
+ end
+
+ describe "news named routing" do
+ describe "GET #show" do
+ context "for root" do
+ it do
+ expect(get(widgets_news_path))
+ .to route_to(controller: "grids/widgets/news", action: "show")
+ end
+ end
+
+ context "with project" do
+ it do
+ expect(get(project_widgets_news_path("my-project")))
+ .to route_to(controller: "grids/widgets/news", action: "show", project_id: "my-project")
+ end
+ end
+ end
+ end
+end
diff --git a/modules/overviews/app/controllers/overviews/widget_controller.rb b/modules/overviews/app/controllers/overviews/widget_controller.rb
index 342f3fcf7e8..7c5c3ece6c8 100644
--- a/modules/overviews/app/controllers/overviews/widget_controller.rb
+++ b/modules/overviews/app/controllers/overviews/widget_controller.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-class Overviews::WidgetController < Grids::BaseInOptionalProjectController
+class Overviews::WidgetController < Grids::BaseInProjectController
include OpTurbo::ComponentStream
include OpTurbo::FlashStreamHelper
diff --git a/modules/overviews/app/controllers/overviews/widgets/project_statuses_controller.rb b/modules/overviews/app/controllers/overviews/widgets/project_statuses_controller.rb
index b4c02a4898d..9019ffbd0d9 100644
--- a/modules/overviews/app/controllers/overviews/widgets/project_statuses_controller.rb
+++ b/modules/overviews/app/controllers/overviews/widgets/project_statuses_controller.rb
@@ -28,7 +28,7 @@
# See COPYRIGHT and LICENSE files for more details.
#++
-class Overviews::Widgets::ProjectStatusesController < Overviews::ProjectWidgetController
+class Overviews::Widgets::ProjectStatusesController < Overviews::WidgetController
def update
call = Projects::UpdateService
.new(model: @project, user: current_user)
diff --git a/modules/overviews/config/routes.rb b/modules/overviews/config/routes.rb
index e681ea96123..a519839a7e8 100644
--- a/modules/overviews/config/routes.rb
+++ b/modules/overviews/config/routes.rb
@@ -17,18 +17,11 @@ Rails.application.routes.draw do
namespace :widgets do
resource :project_status, only: %i[show update]
- resource :news, only: %i[show]
end
end
end
end
- scope module: "overviews" do
- namespace :widgets do
- resource :news, only: %i[show]
- end
- end
-
resources :project_phases, controller: "overviews/project_phases", only: %i[edit update] do
put :preview, on: :member
end
diff --git a/modules/overviews/lib/overviews/engine.rb b/modules/overviews/lib/overviews/engine.rb
index b2f283869eb..6d40231fc56 100644
--- a/modules/overviews/lib/overviews/engine.rb
+++ b/modules/overviews/lib/overviews/engine.rb
@@ -48,8 +48,7 @@ module Overviews
.controller_actions
.push(
"overviews/overviews/show",
- "overviews/widgets/project_statuses/show",
- "overviews/widgets/news/show"
+ "overviews/widgets/project_statuses/show"
)
OpenProject::AccessControl.permission(:edit_project)
diff --git a/modules/overviews/spec/routing/widget_routing_spec.rb b/modules/overviews/spec/routing/widget_routing_spec.rb
index 795bfc0d97a..e25a6a6e6da 100644
--- a/modules/overviews/spec/routing/widget_routing_spec.rb
+++ b/modules/overviews/spec/routing/widget_routing_spec.rb
@@ -58,17 +58,6 @@ RSpec.describe Overviews::WidgetController do
end
end
- describe "news routing" do
- describe "GET #show" do
- it do
- expect(get("/projects/my-project/widgets/news"))
- .to route_to(
- controller: "overviews/widgets/news", action: "show", project_id: "my-project"
- )
- end
- end
- end
-
describe "project_status named routing" do
describe "GET #show" do
it do
@@ -95,15 +84,4 @@ RSpec.describe Overviews::WidgetController do
end
end
end
-
- describe "news named routing" do
- describe "GET #show" do
- it do
- expect(get(project_widgets_news_path("my-project")))
- .to route_to(
- controller: "overviews/widgets/news", action: "show", project_id: "my-project"
- )
- end
- end
- end
end