view_component 4.0.1 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6c8e5b159f5df04cb7bb7e4477670ef3953ec682d7167658e1a4d180302d5366
-  data.tar.gz: bfdfb839583d7e7e27f020fcce04baefeaad676e1ca3ae23864e633e343d5b26
+  metadata.gz: 05c8fa66735f8008894ba88d64885dc307bc71381e2b88391798fa4266da7279
+  data.tar.gz: f217babfa1c1894f377fff73fc3b603755122422c8596e349ffd0d8689e86708
 SHA512:
-  metadata.gz: 2f262abd83ace33712a19c8fa38d6aff0c1853c59647c8edd916a079e6398537ae3201eb9fd5cf1ad08836d9835868d0fae52aff307609220930bf59040c8976
-  data.tar.gz: 303778089d5c4621a1ac038b0a240552332cef8e8acc7c1b08ede206b03b51a11c7727a6e42714db307844f86ec2c78e519eaf5fad49fcac461e8f90cc0e73ee
+  metadata.gz: a10d8362a64c181f11dd0aff69725eb7045a4a4cb546c2e960183bf416083dc8b5bcee76c807be3341dd01919eba3fdc2636083de2794101d8751f1c405396a1
+  data.tar.gz: 2ae8c40ff912472d16d27e3a92af772905d74b3ab010ced00578208ee281f53f59adc31bc0ef0b170cf1ea8c64cd0750db0c0804bb65deca11a33f430cc7012d

data/docs/CHANGELOG.md

@@ -10,6 +10,13 @@ nav_order: 6
 
 ## main
 
+## 4.0.2
+
+* Share the view context in tests to prevent out-of-order rendering issues for certain advanced use-cases, eg. testing instances of Rails' `FormBuilder`.
+* Fix double rendering issue for partials that yield.
+
+    *Cameron Dutro*
+
 ## 4.0.1
 
 * Setup Trusted Publishing to RubyGems to improve software supply chain safety.

data/lib/view_component/base.rb

@@ -246,17 +246,32 @@ module ViewComponent
 
     # Re-use original view_context if we're not rendering a component.
     #
-    # This prevents an exception when rendering a partial inside of a component that has also been rendered outside
-    # of the component. This is due to the partials compiled template method existing in the parent `view_context`,
-    # and not the component's `view_context`.
+    # As of v4, ViewComponent::Base re-uses the existing view context created
+    # by ActionView, meaning the current view context and the original view
+    # context are the same object. set_original_view_context is still called
+    # to maintain backwards compatibility.
     #
     # @private
     def render(options = {}, args = {}, &block)
       if options.respond_to?(:set_original_view_context)
         options.set_original_view_context(self.__vc_original_view_context)
+
+        # We assume options is a component, so there's no need to evaluate the
+        # block in the view context as we do below.
         @view_context.render(options, args, &block)
+      elsif block
+        __vc_original_view_context.render(options, args) do
+          # 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)
+        end
       else
-        __vc_original_view_context.render(options, args, &block)
+        __vc_original_view_context.render(options, args)
       end
     end
 

data/lib/view_component/test_helpers.rb

@@ -38,9 +38,19 @@ module ViewComponent
     # @return [Nokogiri::HTML5]
     def render_inline(component, **args, &block)
       @page = nil
-      @rendered_content = vc_test_controller.view_context.render(component, args, &block)
+      @rendered_content = vc_test_view_context.render(component, args, &block)
 
-      Nokogiri::HTML5.fragment(@rendered_content)
+      fragment = Nokogiri::HTML5.fragment(@rendered_content)
+      @vc_test_view_context = nil
+      fragment
+    end
+
+    # Returns the view context used to render components in tests. Note that the view context
+    # is reset after each call to `render_inline`.
+    #
+    # @return [ActionView::Base]
+    def vc_test_view_context
+      @vc_test_view_context ||= vc_test_controller.view_context
     end
 
     # `JSON.parse`-d component output.
@@ -103,7 +113,7 @@ module ViewComponent
     # ```
     def render_in_view_context(...)
       @page = nil
-      @rendered_content = vc_test_controller.view_context.instance_exec(...)
+      @rendered_content = vc_test_view_context.instance_exec(...)
       Nokogiri::HTML5.fragment(@rendered_content)
     end
 

data/lib/view_component/version.rb

@@ -4,7 +4,7 @@ module ViewComponent
   module VERSION
     MAJOR = 4
     MINOR = 0
-    PATCH = 1
+    PATCH = 2
     PRE = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.0.2
 platform: ruby
 authors:
 - ViewComponent Team