Merge pull request #2362 from ViewComponent/2359-virtual-path-clobber

Fix bug where virtual path was not reset, breaking translations outside of components

Author: joelhawksley

Rakefile

@@ -131,6 +131,8 @@ namespace :docs do
 end
 
 task :all_tests do
+  ENV["RAILS_ENV"] = "test"
+
   if ENV["MEASURE_COVERAGE"]
     SimpleCov.start do
       command_name "rails#{Rails::VERSION::STRING}-ruby#{RUBY_VERSION}"

docs/CHANGELOG.md

@@ -18,6 +18,10 @@ nav_order: 6
 
     *Meyric Rawlings*, *Joel Hawksley*
 
+* Fix bug where virtual path wasn't reset, breaking translations outside of components.
+
+    *Alex Coles*, *Joel Hawksley*
+
 ## 4.0.0.alpha7
 
 * BREAKING: Remove deprecated `use_helper(s)`. Use `include MyHelper` or `helpers.` proxy instead.

lib/view_component/base.rb

@@ -108,6 +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)
       self.__vc_original_view_context ||= view_context
 
       @output_buffer = view_context.output_buffer
@@ -140,6 +141,8 @@ def render_in(view_context, &block)
         value = nil
 
         @output_buffer.with_buffer do
+          @view_context.instance_variable_set(:@virtual_path, virtual_path)
+
           rendered_template = render_template_for(@__vc_requested_details).to_s
 
           # Avoid allocating new string when output_preamble and output_postamble are blank
@@ -160,6 +163,7 @@ def render_in(view_context, &block)
         ""
       end
     ensure
+      view_context.instance_variable_set(:@virtual_path, old_virtual_path)
       @current_template = old_current_template
     end
 

lib/view_component/template.rb

@@ -98,9 +98,8 @@ def compile_to_component
       @component.silence_redefinition_of_method(call_method_name)
 
       # rubocop:disable Style/EvalWithLocation
-      @component.class_eval <<~RUBY, @path, @lineno - 1
+      @component.class_eval <<~RUBY, @path, @lineno
         def #{call_method_name}
-          @view_context.instance_variable_set(:@virtual_path, virtual_path)
           #{compiled_source}
         end
       RUBY

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

@@ -0,0 +1,7 @@
+<p>Virtual path: <%= @virtual_path %></p>
+<p id="before"><%= t(".message") %></p>
+
+<%= render MyComponent.new %>
+
+<p>Virtual path: <%= @virtual_path %></p>
+<p id="after"><%= t(".message") %></p>

test/sandbox/config/locales/en.yml

@@ -15,3 +15,10 @@ en:
 
   editorb_component:
     title: Editorb!
+
+  integration_examples:
+    virtual_path_reset:
+      message: "Hello world!"
+
+  my_component:
+    message: "OH NO! (you shouldn't see me)"

test/sandbox/config/routes.rb

@@ -33,6 +33,7 @@
   get :unsafe_postamble_component, to: "integration_examples#unsafe_postamble_component"
   get :multiple_formats_component, to: "integration_examples#multiple_formats_component"
   get :slotable_default_override, to: "integration_examples#slotable_default_override"
+  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"
   post :submit, to: "integration_examples#submit"

test/sandbox/test/integration_test.rb

@@ -767,4 +767,11 @@ def test_modifying_previews_reflected_on_reload
     get "/rails/view_components/preview_component/default"
     assert_select "h1", text: "Lorem Ipsum"
   end
+
+  def test_virtual_path_reset
+    get "/virtual_path_reset"
+
+    assert_select "#before", text: "Hello world!"
+    assert_select "#after", text: "Hello world!"
+  end
 end

test/sandbox/test/translatable_test.rb

@@ -184,6 +184,9 @@ def test_inheriting_and_overriding_translations
   def translate(key, **options)
     component = TranslatableComponent.new
     render_inline(component)
+    component
+      .instance_variable_get(:@view_context)
+      .instance_variable_set(:@virtual_path, component.virtual_path)
     component.translate(key, **options)
   end
 end