Merge pull request #2389 from ViewComponent/2386-translate-in-block

Use original virtual path when capturing blocks

Author: joelhawksley

docs/CHANGELOG.md

@@ -10,6 +10,10 @@ nav_order: 6
 
 ## main
 
+* Fix bug where relative paths in `translate` didn't work in blocks passed to ViewComponents.
+
+    *Joel Hawksley*
+
 * Add SerpApi to "Who uses ViewComponent" list
 
     *Andy from SerpApi*

lib/view_component/base.rb

@@ -108,7 +108,7 @@ def render_in(view_context, &block)
       self.class.__vc_compile(raise_errors: true)
 
       @view_context = view_context
-      old_virtual_path = view_context.instance_variable_get(:@virtual_path)
+      @old_virtual_path = view_context.instance_variable_get(:@virtual_path)
       self.__vc_original_view_context ||= view_context
 
       @output_buffer = view_context.output_buffer
@@ -166,7 +166,7 @@ def render_in(view_context, &block)
         ""
       end
     ensure
-      view_context.instance_variable_set(:@virtual_path, old_virtual_path)
+      view_context.instance_variable_set(:@virtual_path, @old_virtual_path)
       @current_template = old_current_template
     end
 
@@ -341,7 +341,9 @@ def content
 
       @__vc_content =
         if __vc_render_in_block_provided?
-          view_context.capture(self, &@__vc_render_in_block)
+          with_original_virtual_path do
+            view_context.capture(self, &@__vc_render_in_block)
+          end
         elsif __vc_content_set_by_with_content_defined?
           @__vc_content_set_by_with_content
         end
@@ -358,6 +360,14 @@ def format
       self.class.__vc_response_format
     end
 
+    # @private
+    def with_original_virtual_path
+      @view_context.instance_variable_set(:@virtual_path, @old_virtual_path)
+      yield
+    ensure
+      @view_context.instance_variable_set(:@virtual_path, virtual_path)
+    end
+
     private
 
     attr_reader :view_context

lib/view_component/slot.rb

@@ -58,15 +58,19 @@ def to_s
           if defined?(@__vc_content_block)
             # render_in is faster than `parent.render`
             @__vc_component_instance.render_in(view_context) do |*args|
-              @__vc_content_block.call(*args)
+              @parent.with_original_virtual_path do
+                @__vc_content_block.call(*args)
+              end
             end
           else
             @__vc_component_instance.render_in(view_context)
           end
         elsif defined?(@__vc_content)
           @__vc_content
         elsif defined?(@__vc_content_block)
-          view_context.capture(&@__vc_content_block)
+          @parent.with_original_virtual_path do
+            view_context.capture(&@__vc_content_block)
+          end
         elsif defined?(@__vc_content_set_by_with_content)
           @__vc_content_set_by_with_content
         end

test/sandbox/app/views/integration_examples/translations_in_block.html.erb

@@ -0,0 +1,21 @@
+<div id="outside"><%= t(".local_relative_key") %></div>
+
+<div id="inside">
+  <%= render(MyComponent.new) do %>
+    <%= t(".local_relative_key") %>
+  <% end %>
+</div>
+
+<div id="slot">
+  <%= render(SlotsComponent.new) do |component| %>
+    <% component.with_title do %>
+      <%= t(".local_relative_key") %>
+    <% end %>
+    <% component.with_item do %>
+      <%= t(".local_relative_key") %>
+    <% end %>
+    <% component.with_footer do %>
+      <%= t(".local_relative_key") %>
+    <% end %>
+  <% end %>
+</div>

test/sandbox/config/locales/en.yml

@@ -19,6 +19,8 @@ en:
   integration_examples:
     virtual_path_reset:
       message: "Hello world!"
+    translations_in_block:
+      local_relative_key: "Local translation"
 
   my_component:
     message: "OH NO! (you shouldn't see me)"

test/sandbox/config/routes.rb

@@ -36,6 +36,7 @@
   get :virtual_path_reset, to: "integration_examples#virtual_path_reset"
   post :create, to: "integration_examples#create"
   get :turbo_content_type, to: "integration_examples#turbo_content_type"
+  get :translations_in_block, to: "integration_examples#translations_in_block"
   post :submit, to: "integration_examples#submit"
 
   resources :posts

test/sandbox/test/integration_test.rb

@@ -774,4 +774,14 @@ def test_virtual_path_reset
     assert_select "#before", text: "Hello world!"
     assert_select "#after", text: "Hello world!"
   end
+
+  def test_works_with_translations_in_block
+    get "/translations_in_block"
+
+    assert_select "#outside", text: "Local translation"
+    assert_select "#inside", text: "hello,world! Local translation"
+    assert_select "#slot .title", text: "Local translation"
+    assert_select "#slot .item", text: "Local translation"
+    assert_select "#slot .footer", text: "Local translation"
+  end
 end