Merge pull request #3765 from AlchemyCMS/admin-user-name-component

feat: Extract admin user name display into component

Author: tvdeyen

app/components/alchemy/admin/current_user_name.rb

@@ -0,0 +1,34 @@
+module Alchemy
+  module Admin
+    # This component is used to display the name of the current Alchemy user in the admin interface.
+    class CurrentUserName < ViewComponent::Base
+      def initialize(user:)
+        @user = user
+        @display_name = user.try(:alchemy_display_name)
+      end
+
+      def call
+        tag.span class: "current-user-name" do
+          safe_join [
+            '<alchemy-icon name="user" size="1x"></alchemy-icon>'.html_safe,
+            link_to_if(edit_user_path, display_name, edit_user_path)
+          ]
+        end
+      end
+
+      def render?
+        user && display_name.present?
+      end
+
+      private
+
+      attr_reader :user, :display_name
+
+      def edit_user_path
+        return unless Alchemy.config.edit_user_path
+
+        Alchemy.config.edit_user_path.gsub(":id", user.id.to_s)
+      end
+    end
+  end
+end

app/helpers/alchemy/admin/base_helper.rb

@@ -17,15 +17,12 @@ module BaseHelper
       #
       # In order to represent your own +User+'s class instance,
       # you should add a +alchemy_display_name+ method to your +User+ class
-      #
+      # @deprecated Use the +CurrentAlchemyUserName+ component instead.
       def current_alchemy_user_name
-        name = current_alchemy_user.try(:alchemy_display_name)
-        if name.present?
-          content_tag :span, class: "current-user-name" do
-            "#{render_icon(:user, size: "1x")} #{name}".html_safe
-          end
-        end
+        render Alchemy::Admin::CurrentUserName.new(user: current_alchemy_user)
       end
+      deprecate current_alchemy_user_name: "Use the Alchemy::Admin::CurrentUserName component instead.",
+        deprecator: Alchemy::Deprecation
 
       # This helper renders the link to an dialog.
       #

app/views/alchemy/admin/_user_info.html.erb

@@ -1,5 +1,5 @@
 <div id="user_info">
-  <%= current_alchemy_user_name %>
+  <%= render Alchemy::Admin::CurrentUserName.new(user: current_alchemy_user) %>
   <%= render Alchemy::Admin::TimezoneSelect.new %>
   <%= render Alchemy::Admin::LocaleSelect.new %>
 </div>

lib/alchemy/configurations/main.rb

@@ -434,6 +434,18 @@ def user_class_name = "::#{raw_user_class}"
       # The path to the page showing the user they're unauthorized
       option :unauthorized_path, :string, default: "/"
 
+      # === Edit User Path
+      #
+      # The path to the edit user form.
+      #
+      # == Example
+      #
+      #     "/admin/users/:id/edit"
+      #
+      # NOTE: The :id placeholder will be replaced with the current_alchemy_user's id.
+      #
+      option :edit_user_path, :string
+
       # === CanCan abilities
       #
       # If your app or your engine has own CanCan abilities you must register them.

spec/components/alchemy/admin/current_user_name_spec.rb

@@ -0,0 +1,45 @@
+require "rails_helper"
+
+RSpec.describe Alchemy::Admin::CurrentUserName, type: :component do
+  subject(:render) do
+    render_inline described_class.new(user:)
+    rendered_content
+  end
+
+  context "with no user" do
+    let(:user) { nil }
+
+    it { expect(render).to be_blank }
+  end
+
+  context "with a user" do
+    context "having a `alchemy_display_name` method" do
+      let(:user) { double("User", alchemy_display_name: "Peter Schroeder") }
+
+      it "Returns a span showing the name of the currently logged in user." do
+        render
+        expect(page).to have_content("Peter Schroeder")
+        expect(page).to have_selector("span.current-user-name")
+      end
+    end
+
+    context "not having a `alchemy_display_name` method" do
+      let(:user) { double("User", name: "Peter Schroeder") }
+
+      it { expect(render).to be_blank }
+    end
+
+    context "with an edit_user_path configured" do
+      before do
+        stub_alchemy_config(edit_user_path: "/users/:id/edit")
+        render
+      end
+
+      let(:user) { double("User", id: 42, alchemy_display_name: "Peter Schroeder") }
+
+      it "links the user name to the edit user path" do
+        expect(page).to have_link("Peter Schroeder", href: "/users/42/edit")
+      end
+    end
+  end
+end

spec/helpers/alchemy/admin/base_helper_spec.rb

@@ -178,21 +178,16 @@ module Alchemy
     describe "#current_alchemy_user_name" do
       subject { helper.current_alchemy_user_name }
 
-      before { expect(helper).to receive(:current_alchemy_user).and_return(user) }
+      let(:user) { double("User", alchemy_display_name: "Peter Schroeder") }
 
-      context "with a user having a `alchemy_display_name` method" do
-        let(:user) { double("User", alchemy_display_name: "Peter Schroeder") }
-
-        it "Returns a span showing the name of the currently logged in user." do
-          is_expected.to have_content("Peter Schroeder")
-          is_expected.to have_selector("span.current-user-name")
-        end
+      before do
+        expect(helper).to receive(:current_alchemy_user).and_return(user)
+        allow(helper).to receive(:render).with(instance_of(Alchemy::Admin::CurrentUserName))
       end
 
-      context "with a user not having a `alchemy_display_name` method" do
-        let(:user) { double("User", name: "Peter Schroeder") }
-
-        it { is_expected.to be_nil }
+      it "renders the Alchemy::Admin::CurrentUserName component", :silence_deprecations do
+        subject
+        expect(helper).to have_received(:render).with(instance_of(Alchemy::Admin::CurrentUserName))
       end
     end