Add prefix to use_helper(s) (#2064)

* add: implementation, docs comming soon

* add named prefixes

* add docs and collection implementation

* add changelog entry

* Update docs/CHANGELOG.md

---------

Co-authored-by: Joel Hawksley <[email protected]>
Co-authored-by: Joel Hawksley <[email protected]>

Author: reeganviljoen

docs/CHANGELOG.md

@@ -18,6 +18,10 @@ nav_order: 5
 
     *Seth Herr*
 
+* Add `prefix:` option to `use_helpers`.
+
+    *Reegan Viljoen*
+
 ## 3.13.0
 
 * Add ruby head and YJIT to CI.

docs/guide/helpers.md

@@ -81,6 +81,30 @@ class UserComponent < ViewComponent::Base
 end
 ```
 
+Use the `prefix:` keyword to prefix the helper method with the name of the helper module:
+
+```ruby
+class UserComponent < ViewComponent::Base
+  use_helpers :icon, :icon?, from: IconHelper, prefix: true
+
+  def profile_icon
+    icon_helper_icon? ? icon_helper_icon(:user) : icon_helper_icon(:guest)
+  end
+end
+```
+
+or use the `prefix:` keyword with a custom prefix:
+
+```ruby
+class UserComponent < ViewComponent::Base
+  use_helpers :icon, :icon?, from: IconHelper, prefix: :user
+
+  def profile_icon
+    user_icon? ? user_icon(:user) : user_icon(:guest)
+  end
+end
+```
+
 The singular version `use_helper` is also available:
 
 ```ruby

lib/view_component/use_helpers.rb

@@ -4,23 +4,35 @@ module ViewComponent::UseHelpers
   extend ActiveSupport::Concern
 
   class_methods do
-    def use_helpers(*args, from: nil)
-      args.each { |helper_method| use_helper(helper_method, from: from) }
+    def use_helpers(*args, from: nil, prefix: false)
+      args.each { |helper_method| use_helper(helper_method, from: from, prefix: prefix) }
     end
 
-    def use_helper(helper_method, from: nil)
+    def use_helper(helper_method, from: nil, prefix: false)
+      helper_method_name = full_helper_method_name(helper_method, prefix: prefix, source: from)
+
       class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-        def #{helper_method}(*args, &block)
+        def #{helper_method_name}(*args, &block)
           raise HelpersCalledBeforeRenderError if view_context.nil?
 
           #{define_helper(helper_method: helper_method, source: from)}
         end
       RUBY
-      ruby2_keywords(helper_method) if respond_to?(:ruby2_keywords, true)
+      ruby2_keywords(helper_method_name) if respond_to?(:ruby2_keywords, true)
     end
 
     private
 
+    def full_helper_method_name(helper_method, prefix: false, source: nil)
+      return helper_method unless prefix.present?
+
+      if !!prefix == prefix
+        "#{source.to_s.underscore}_#{helper_method}"
+      else
+        "#{prefix}_#{helper_method}"
+      end
+    end
+
     def define_helper(helper_method:, source:)
       return "__vc_original_view_context.#{helper_method}(*args, &block)" unless source.present?
 

test/sandbox/app/components/use_helper_macro_component.html copy.erb renamed to test/sandbox/app/components/use_helper_macro_component.html.erb

@@ -10,6 +10,14 @@
   <%= message_with_kwargs(name: 'macro kwargs helper method') %>
 </div>
 
+<div class='helper__prefix-message'>
+  <%= macro_helper_message_with_prefix('macro prefix helper method') %>
+</div>
+
+<div class='helper__prefix-message'>
+  <%= named_message_with_named_prefix('macro named prefix helper method') %>
+</div>
+
 <div class='helper__block-message'>
   <%= block_content %>
 </div>

test/sandbox/app/components/use_helper_macro_component.rb

@@ -4,7 +4,9 @@ class UseHelperMacroComponent < ViewComponent::Base
   use_helper :message, from: MacroHelper
   use_helper :message_with_args, from: MacroHelper
   use_helper :message_with_kwargs, from: MacroHelper
+  use_helper :message_with_prefix, from: MacroHelper, prefix: true
   use_helper :message_with_block, from: MacroHelper
+  use_helper :message_with_named_prefix, from: MacroHelper, prefix: :named
 
   def block_content
     message_with_block { "Hello block helper method" }

test/sandbox/app/components/use_helpers_macro_component.html.erb

@@ -13,3 +13,11 @@
 <div class='helper__block-message'>
   <%= block_content %>
 </div>
+
+<div class='helper__prefix-message'>
+  <%= macro_helper_message_with_args('macro prefix helper method') %>
+</div>
+
+<div class='helper__named-prefix-message'>
+  <%= named_message_with_args('macro named prefix helper method') %>
+</div>

test/sandbox/app/components/use_helpers_macro_component.rb

@@ -3,6 +3,10 @@
 class UseHelpersMacroComponent < ViewComponent::Base
   use_helpers :message, :message_with_args, :message_with_kwargs, :message_with_block, from: MacroHelper
 
+  use_helpers :message_with_args, from: MacroHelper, prefix: true
+
+  use_helpers :message_with_args, from: MacroHelper, prefix: :named
+
   def block_content
     message_with_block { "Hello block helper method" }
   end

test/sandbox/app/helpers/macro_helper.rb

@@ -13,6 +13,14 @@ def message_with_kwargs(name:)
     "Hello #{name}"
   end
 
+  def message_with_prefix(name)
+    "Hello #{name}"
+  end
+
+  def message_with_named_prefix(name)
+    "Hello #{name}"
+  end
+
   def message_with_block
     yield
   end

test/sandbox/test/rendering_test.rb

@@ -1169,4 +1169,28 @@ def test_use_helper_macros_with_block
 
     assert_selector ".helper__block-message", text: "Hello block helper method"
   end
+
+  def test_use_helper_macros_with_prefix
+    render_inline(UseHelperMacroComponent.new)
+
+    assert_selector ".helper__prefix-message", text: "Hello macro prefix helper method"
+  end
+
+  def test_use_helper_macros_with_named_prefix
+    render_inline(UseHelperMacroComponent.new)
+
+    assert_selector ".helper__prefix-message", text: "Hello macro named prefix helper method"
+  end
+
+  def test_use_helpers_macros_with_prefix
+    render_inline(UseHelpersMacroComponent.new)
+
+    assert_selector ".helper__prefix-message", text: "Hello macro prefix helper method"
+  end
+
+  def test_use_helpers_macros_with_named_prefix
+    render_inline(UseHelpersMacroComponent.new)
+
+    assert_selector ".helper__named-prefix-message", text: "Hello macro named prefix helper method"
+  end
 end