Extract dev_tools from OP monorepo module

README.md

@@ -1,2 +1,19 @@
 # openproject-dev_tools
-OpenProject plugin adding tools helping with local development of OpenProject
+
+An OpenProject plugin that adds development tools to make local development easier.
+
+> **:warning: This plugin is intended for local development only. Do not use it in production.**
+
+## Tools
+
+- **User switcher**: A dropdown in the top navigation bar listing all active users. Click any user to immediately switch to them.
+
+## Installation
+
+Add it like this to the `Gemfile.local` file:
+
+```ruby
+group :development do
+  gem 'openproject-dev_tools', github: 'opf/openproject-dev_tools'
+end
+```

app/components/dev_tools_user_switcher/component.html.erb

@@ -0,0 +1,58 @@
+<%#-- 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.
+
+++#%>
+
+<%=
+  render(
+    Primer::Alpha::ActionMenu.new(
+      classes: "op-app-menu--item",
+      style: "order: 1",
+      menu_id: "op-dev-user-switcher-menu",
+      select_variant: :single
+    )
+  ) do |menu|
+    menu.with_show_button(
+      scheme: :invisible,
+      classes: "op-app-header--primer-button"
+    ) do |button|
+      button.with_leading_visual_icon(icon: :"person-add")
+      button.with_tooltip(text: I18n.t("dev_tools.user_switcher.tooltip"))
+
+      current_user_name
+    end
+
+    users.each do |user|
+      menu  .with_item(
+        href: dev_tools_switch_user_path(user_id: user.id),
+        label: user.name,
+        content_arguments: { data: { "turbo-method": "post" } },
+        active: user == User.current
+      )
+    end
+  end
+%>

app/components/dev_tools_user_switcher/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 DevToolsUserSwitcher
+  class Component < ApplicationComponent
+    def users
+      @users ||= User.active
+                     .not_builtin
+                     .order(:id)
+    end
+
+    def current_user_name
+      User.current.name
+    end
+  end
+end

app/controllers/dev_tools/user_switcher_controller.rb

@@ -0,0 +1,49 @@
+# 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 DevTools
+  class UserSwitcherController < ApplicationController
+    no_authorization_required! :switch
+    skip_before_action :check_if_login_required
+
+    def switch
+      user = User.find_by(id: params[:user_id])
+
+      if user&.active?
+        login_user(user)
+        flash[:notice] = I18n.t("dev_tools.user_switcher.switched", name: user.name)
+      else
+        flash[:error] = I18n.t("dev_tools.user_switcher.user_not_found")
+      end
+
+      redirect_back_or_to root_path
+    end
+  end
+end

config/locales/en.yml

@@ -0,0 +1,9 @@
+en:
+  dev_tools:
+    user_switcher:
+      switched: "Switched to user: %{name}"
+      user_not_found: "User not found or inactive"
+      title: "Switch User (Dev Only)"
+      tooltip: "Switch User (Dev Only)"
+      heading: "Switch User (Dev Only)"
+      active_users: "Active Users"

config/routes.rb

@@ -0,0 +1,35 @@
+# 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.
+#++
+
+OpenProject::Application.routes.draw do
+  scope module: :dev_tools, path: "dev_tools", as: :dev_tools do
+    match "switch_user", to: "user_switcher#switch", via: %i[get post]
+  end
+end

dev_tools.gemspec

@@ -0,0 +1,42 @@
+# 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.
+#++
+
+Gem::Specification.new do |s|
+  s.name        = "openproject-dev_tools"
+  s.version     = "1.0.0"
+  s.authors     = "OpenProject GmbH"
+  s.email       = "info@openproject.com"
+  s.summary     = "OpenProject Development Tools"
+  s.description = "Development only tools for OpenProject (user switcher, custom styles, etc.)"
+  s.license     = "GPL-3.0"
+
+  s.files = Dir["{app,config,lib}/**/*"]
+  s.metadata["rubygems_mfa_required"] = "true"
+end

lib/open_project/dev_tools.rb

@@ -0,0 +1,64 @@
+# 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.
+#++# 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 "open_project/dev_tools/engine"
+
+module OpenProject
+  module DevTools
+  end
+end

lib/open_project/dev_tools/engine.rb

@@ -0,0 +1,50 @@
+# 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 "open_project/plugins"
+
+module OpenProject
+  module DevTools
+    class Engine < ::Rails::Engine
+      engine_name :openproject_dev_tools
+
+      include OpenProject::Plugins::ActsAsOpEngine
+
+      register "openproject-dev_tools",
+               author_url: "https://www.openproject.org",
+               bundled: false,
+               name: "OpenProject Dev Tools"
+
+      config.to_prepare do
+        OpenProject::DevTools::Hooks::LayoutHook
+      end
+    end
+  end
+end