Merge branch 'main' into render_inline_nokogiri_contextless

joelhawksley · web-flow · commit bd712d9f6a5a · 2025-12-03T15:44:49.000-07:00
diff --git a/Gemfile b/Gemfile
@@ -21,7 +21,7 @@ group :development, :test do
   gem "cuprite"
   gem "dry-initializer", require: true
   gem "erb_lint"
-  gem "haml", "~> 6"
+  gem "haml", "~> 7"
   gem "jbuilder", "~> 2"
   gem "m", "~> 1"
   gem "method_source", "~> 1"
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -141,7 +141,7 @@ GEM
       websocket-driver (~> 0.7)
     globalid (1.3.0)
       activesupport (>= 6.1)
-    haml (6.4.0)
+    haml (7.0.2)
       temple (>= 0.8.2)
       thor
       tilt
@@ -428,7 +428,7 @@ DEPENDENCIES
   cuprite
   dry-initializer
   erb_lint
-  haml (~> 6)
+  haml (~> 7)
   jbuilder (~> 2)
   m (~> 1)
   method_source (~> 1)
diff --git a/docs/CHANGELOG.md b/docs/CHANGELOG.md
@@ -10,10 +10,30 @@ nav_order: 6
 
 ## main
 
-* Allow render_inline with Nokogiri::HTML5 to parse more arbitrary content including bare table content otherwise illegal fragments like <td>)
+* Allow `render_inline` with Nokogiri::HTML5 to parse more arbitrary content including bare table content otherwise illegal fragments like `<td>`.
 
     *Jonathan Rochkind*
 
+* Add test to document the current behavior for resolving relative translation keys within partial blocks. When rendering a partial, relative translation keys are resolved relative to the partial's own path rather than the caller’s path. This test ensures that this behavior remains consistent.
+
+    *Oussama Hilal*
+
+* Allow I18n calls in `render?`.
+
+    *23tux*
+
+* ViewComponent now works without `rails` and `railties` gems loaded, enabling compatibility with Bridgetown 2.0.
+
+    *Tom Lord*
+
+* Capture partial block in the component's context, allowing access to the component instance inside the block.
+
+    *23tux*
+
+* Add `after_compile` class method hook to enable extensions to run logic after component compilation.
+
+    *Jose Solás*
+
 * Fix outdated reference to preview layout configuration in docs.
 
     *Lucas Geron*
diff --git a/lib/view_component.rb b/lib/view_component.rb
@@ -17,7 +17,7 @@ module ViewComponent
   autoload :Preview
   autoload :Translatable
 
-  if Rails.env.test?
+  if defined?(Rails.env) && Rails.env.test?
     autoload :TestHelpers
     autoload :SystemSpecHelpers
     autoload :SystemTestHelpers
diff --git a/lib/view_component/base.rb b/lib/view_component/base.rb
@@ -46,7 +46,7 @@ def config
     end
 
     include ActionView::Helpers
-    include Rails.application.routes.url_helpers if defined?(Rails) && Rails.application
+    include Rails.application.routes.url_helpers if defined?(Rails.application.routes)
     include ERB::Escape
     include ActiveSupport::CoreExt::ERBUtil
 
@@ -131,15 +131,14 @@ def render_in(view_context, &block)
 
       @__vc_content_evaluated = false
       @__vc_render_in_block = block
+      @view_context.instance_variable_set(:@virtual_path, virtual_path)
 
       before_render
 
       if render?
         value = nil
 
         @output_buffer.with_buffer do
-          @view_context.instance_variable_set(:@virtual_path, virtual_path)
-
           rendered_template =
             around_render do
               render_template_for(@__vc_requested_details).to_s
@@ -260,14 +259,17 @@ def render(options = {}, args = {}, &block)
         @view_context.render(options, args, &block)
       elsif block
         __vc_original_view_context.render(options, args) do
+          # capture the block output in the view context of the component
+          output = capture(&block)
+
           # Partials are rendered to their own buffer and do not append to the
           # original @output_buffer we retain a reference to in #render_in. This
           # is a problem since the block passed to us here in the #render method
           # is evaluated within the context of ViewComponent::Base, and thus
           # appends to the original @output_buffer. To avoid this, we evaluate the
           # block in the view context instead, which will append to the output buffer
           # created for the partial.
-          __vc_original_view_context.instance_exec(&block)
+          __vc_original_view_context.capture { output }
         end
       else
         __vc_original_view_context.render(options, args)
@@ -301,7 +303,7 @@ def helpers
       @__vc_helpers ||= __vc_original_view_context || controller.view_context
     end
 
-    if ::Rails.env.development? || ::Rails.env.test?
+    if defined?(Rails.env) && (::Rails.env.development? || ::Rails.env.test?)
       # @private
       def method_missing(method_name, *args) # rubocop:disable Style/MissingRespondToMissing
         super
@@ -330,7 +332,7 @@ def view_cache_dependencies
       []
     end
 
-    if Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR == 1
+    if defined?(Rails::VERSION) && Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR == 1
       # Rails expects us to define `format` on all renderables,
       # but we do not know the `format` of a ViewComponent until runtime.
       def format
@@ -610,6 +612,16 @@ def __vc_compiled?
         __vc_compiler.compiled?
       end
 
+      # Hook called by the compiler after a component is compiled.
+      #
+      # Extensions can override this class method to run logic after
+      # compilation (e.g., generate helpers, register metadata, etc.).
+      #
+      # By default, this is a no-op.
+      def after_compile
+        # no-op by default
+      end
+
       # @private
       def __vc_ensure_compiled
         __vc_compile unless __vc_compiled?
diff --git a/lib/view_component/collection.rb b/lib/view_component/collection.rb
@@ -20,7 +20,7 @@ def each(&block)
       components.each(&block)
     end
 
-    if Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR == 1
+    if defined?(Rails::VERSION) && Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR == 1
       # Rails expects us to define `format` on all renderables,
       # but we do not know the `format` of a ViewComponent until runtime.
       def format
diff --git a/lib/view_component/compiler.rb b/lib/view_component/compiler.rb
@@ -52,6 +52,8 @@ def compile(raise_errors: false, force: false)
         @component.__vc_build_i18n_backend
 
         CompileCache.register(@component)
+
+        @component.after_compile
       end
     end
 
diff --git a/lib/view_component/config.rb b/lib/view_component/config.rb
@@ -163,7 +163,7 @@ def default_previews_options
         options = ActiveSupport::OrderedOptions.new
         options.controller = "ViewComponentsController"
         options.route = "/rails/view_components"
-        options.enabled = Rails.env.development? || Rails.env.test?
+        options.enabled = defined?(Rails.env) && (Rails.env.development? || Rails.env.test?)
         options.default_layout = nil
         options.paths = default_preview_paths
         options
diff --git a/test/sandbox/app/components/partial_with_yield_and_method_call_component.html.erb b/test/sandbox/app/components/partial_with_yield_and_method_call_component.html.erb
@@ -0,0 +1,3 @@
+<%= render "shared/yielding_partial" do %>
+  <%= world %>
+<% end %>
diff --git a/test/sandbox/app/components/partial_with_yield_and_method_call_component.rb b/test/sandbox/app/components/partial_with_yield_and_method_call_component.rb
@@ -0,0 +1,5 @@
+class PartialWithYieldAndMethodCallComponent < ViewComponent::Base
+  def world
+    "world"
+  end
+end
diff --git a/test/sandbox/app/components/relative_translation_partial_block_component.html.erb b/test/sandbox/app/components/relative_translation_partial_block_component.html.erb
@@ -0,0 +1,3 @@
+<%= render "shared/partial" do %>
+  <%= t(".title") %>
+<% end %>
diff --git a/test/sandbox/app/components/relative_translation_partial_block_component.rb b/test/sandbox/app/components/relative_translation_partial_block_component.rb
@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class RelativeTranslationPartialBlockComponent < ViewComponent::Base
+end
diff --git a/test/sandbox/app/components/relative_translation_partial_parent_component.html.erb b/test/sandbox/app/components/relative_translation_partial_parent_component.html.erb
@@ -0,0 +1,3 @@
+<%= render "shared/partial" do %>
+  <%= t(".title") %>
+<% end %>
diff --git a/test/sandbox/app/components/relative_translation_partial_parent_component.rb b/test/sandbox/app/components/relative_translation_partial_parent_component.rb
@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class RelativeTranslationPartialParentComponent < ViewComponent::Base
+end
diff --git a/test/sandbox/app/views/shared/_partial.html.erb b/test/sandbox/app/views/shared/_partial.html.erb
@@ -0,0 +1 @@
+<%= yield %>
diff --git a/test/sandbox/config/locales/en.yml b/test/sandbox/config/locales/en.yml
@@ -24,3 +24,11 @@ en:
 
   my_component:
     message: "OH NO! (you shouldn't see me)"
+
+  shared:
+    partial:
+      title: Partial Title
+
+  rendering_test:
+    i18n_test_component:
+      message: "I can be called in render?"
diff --git a/test/sandbox/test/base_test.rb b/test/sandbox/test/base_test.rb
@@ -195,4 +195,63 @@ def test_uses_module_configuration
     assert_equal false, TestAlreadyConfigurableModule::SomeComponent.instrumentation_enabled
     assert_equal false, TestAlreadyConfiguredModule::SomeComponent.instrumentation_enabled
   end
+
+  def test_after_compile_hook_called_on_compile
+    klass = Class.new(ViewComponent::Base) do
+      @@calls = 0
+
+      def self.calls
+        @@calls
+      end
+
+      class << self
+        def after_compile
+          @@calls += 1
+        end
+      end
+
+      erb_template ""
+    end
+
+    self.class.const_set(:TempHookComponent, klass)
+    ViewComponent::CompileCache.invalidate_class!(klass)
+
+    ViewComponent::Compiler.new(klass).compile(force: true)
+    assert_equal 1, klass.calls
+  ensure
+    self.class.send(:remove_const, :TempHookComponent) if self.class.const_defined?(:TempHookComponent)
+    ViewComponent::CompileCache.invalidate_class!(klass) if defined?(klass)
+  end
+
+  def test_after_compile_not_called_on_cached_compile
+    klass = Class.new(ViewComponent::Base) do
+      @@calls = 0
+
+      def self.calls
+        @@calls
+      end
+
+      class << self
+        def after_compile
+          @@calls += 1
+        end
+      end
+
+      erb_template ""
+    end
+
+    self.class.const_set(:TempHookCachedComponent, klass)
+    ViewComponent::CompileCache.invalidate_class!(klass)
+
+    compiler = ViewComponent::Compiler.new(klass)
+    compiler.compile(force: true)
+    assert_equal 1, klass.calls
+
+    # compile again without force -> should not call hook again
+    compiler.compile
+    assert_equal 1, klass.calls
+  ensure
+    self.class.send(:remove_const, :TempHookCachedComponent) if self.class.const_defined?(:TempHookCachedComponent)
+    ViewComponent::CompileCache.invalidate_class!(klass) if defined?(klass)
+  end
 end
diff --git a/test/sandbox/test/components/relative_translation_partial_component_test.rb b/test/sandbox/test/components/relative_translation_partial_component_test.rb
@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class RelativeTranslationPartialBlockComponentTest < ViewComponent::TestCase
+  def test_relative_translation_in_partial_block
+    render_inline(RelativeTranslationPartialBlockComponent.new)
+
+    assert_text "Partial Title"
+  end
+end
diff --git a/test/sandbox/test/rendering_test.rb b/test/sandbox/test/rendering_test.rb
@@ -1343,4 +1343,30 @@ def test_render_partial_with_yield
     render_inline(PartialWithYieldComponent.new)
     assert_text "hello world", exact: true, normalize_ws: true
   end
+
+  def test_render_partial_with_yield_and_method_call
+    render_inline(PartialWithYieldAndMethodCallComponent.new)
+    assert_text "hello world", exact: true, normalize_ws: true
+  end
+
+  class I18nTestComponent < ViewComponent::Base
+    def message
+      t(".message")
+    end
+
+    def render?
+      message
+    end
+
+    def call
+      content_tag :div, t(".message")
+    end
+  end
+
+  def test_i18n_in_render_hook
+    vc_test_request.params[:hello] = "world"
+    render_inline(I18nTestComponent.new)
+
+    assert_selector("div", text: I18n.t("rendering_test.i18n_test_component.message"))
+  end
 end

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+<%= render "shared/yielding_partial" do %>`
	`2`	`+ <%= world %>`
	`3`	`+<% end %>`
-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +class PartialWithYieldAndMethodCallComponent < ViewComponent::Base
 +  def world
 +    "world"
 +  end
 +end