view_component 4.0.0 → 4.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 315f6566baf49a86b15ce8537b28995fa64c8623c1a541c4cf2bc85891c5f837
-  data.tar.gz: ba7b833f7a0714e076cfc4e343c20532a2cba5737582aa654f143971c8c7a9f1
+  metadata.gz: 05c8fa66735f8008894ba88d64885dc307bc71381e2b88391798fa4266da7279
+  data.tar.gz: f217babfa1c1894f377fff73fc3b603755122422c8596e349ffd0d8689e86708
 SHA512:
-  metadata.gz: 2d7903db688c6c28a3a2a874f2480ec70328b05e081629b6f0fe1f59ae1b049cea41e127ac89de098b256d00a6c1cd20c21b76d2ec04345c550132368dada341
-  data.tar.gz: 1d6ad41497fbb4a4f7fb1a44fbd606897e6e6b88f48933f818b26461834fe414c0c3f840f85fefedf6ed39f206fd07786c8e597a473ef44bdaacecfbb548e43d
+  metadata.gz: a10d8362a64c181f11dd0aff69725eb7045a4a4cb546c2e960183bf416083dc8b5bcee76c807be3341dd01919eba3fdc2636083de2794101d8751f1c405396a1
+  data.tar.gz: 2ae8c40ff912472d16d27e3a92af772905d74b3ab010ced00578208ee281f53f59adc31bc0ef0b170cf1ea8c64cd0750db0c0804bb65deca11a33f430cc7012d

data/docs/CHANGELOG.md

@@ -10,6 +10,25 @@ 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.
+
+    *Hans Lemuet*
+
+* Conditionally add the `ViewComponent::Base#format` method back for Rails 7.1 only.
+* Compute and check lockfiles into source control.
+* Constrain Rails versions in gemfiles to only allow the patch version to vary, eg. `~> 7.1.0` instead of `~> 7.1`.
+
+    *Cameron Dutro*
+
 ## 4.0.0
 
 Two years after releasing [3.0.0](https://github.com/ViewComponent/view_component/releases/tag/v3.0.0) and almost six years since [1.0.0](https://github.com/ViewComponent/view_component/releases/tag/v1.0.0), we're proud to ship ViewComponent 4. This release marks a shift towards a Long Term Support model for the project, having reached significant feature maturity. While contributions are always welcome, we're unlikely to accept further breaking changes or major feature additions.
@@ -37,11 +56,10 @@ Please report any issues at [https://github.com/ViewComponent/view_component/iss
 
 ### Breaking changes (dev/test)
 
-* Rename `config.generate.component_parent_class` to `config.generate.parent_class`.
-* Remove `config.test_controller` in favor of `vc_test_controller_class` test helper method.
-* `config.component_parent_class` is now `config.generate.component_parent_class`, moving the generator-specific option to the generator configuration namespace.
+* Remove `config.view_component.test_controller` in favor of `vc_test_controller_class` test helper method.
+* `config.view_component.component_parent_class` is now `config.view_component.generate.parent_class`, moving the generator-specific option to the generator configuration namespace.
+* `config.view_component.view_component_path` is now `config.view_component.generate.path`, as components have long since been able to exist in any directory.
 * Move previews-related configuration (`enabled`, `route`, `paths`, `default_layout`, `controller`) to under `previews` namespace.
-* `config.view_component_path` is now `config.generate.path`, as components have long since been able to exist in any directory.
 * `--inline` generator option now generates inline template. Use `--call` to generate `#call` method.
 * Remove broken integration with `rails stats` that ignored components outside of `app/components`.
 * Remove `preview_source` functionality. Consider using [Lookbook](https://lookbook.build/) instead.
@@ -66,7 +84,7 @@ Please report any issues at [https://github.com/ViewComponent/view_component/iss
 ### Bug fixes
 
 * Fix bug where virtual path wasn't reset, breaking translations outside of components.
-* Fix bug where `config.previews.enabled` didn't function properly in production environments.
+* Fix bug where `config.view_component.previews.enabled` didn't function properly in production environments.
 * Fix bug in `SlotableDefault` where default couldn't be overridden when content was passed as a block.
 * Fix bug where request-aware helpers didn't work outside of the request context.
 * `ViewComponentsSystemTestController` shouldn't be useable outside of test environment
@@ -81,7 +99,7 @@ Please report any issues at [https://github.com/ViewComponent/view_component/iss
 * Update documentation on performance to reflect more representative benchmark showing 2-3x speed increase over partials.
 * Add documentation note about instrumentation negatively affecting performance.
 * Remove unnecessary ENABLE_RELOADING test suite flag.
-* `config.previews.default_layout` should default to nil.
+* `config.view_component.previews.default_layout` should default to nil.
 * Add test coverage for uncovered code.
 * Test against `turbo-rails` `v2` and `rspec-rails` `v7`.
 

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
 
@@ -316,6 +331,14 @@ module ViewComponent
       []
     end
 
+    if 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
+        nil
+      end
+    end
+
     # The current request. Use sparingly as doing so introduces coupling that
     # inhibits encapsulation & reuse, often making testing difficult.
     #

data/lib/view_component/collection.rb

@@ -19,6 +19,14 @@ module ViewComponent
       components.each(&block)
     end
 
+    if 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
+        nil
+      end
+    end
+
     private
 
     def components

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 = 0
+    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.0
+  version: 4.0.2
 platform: ruby
 authors:
 - ViewComponent Team
@@ -127,7 +127,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: A framework for building reusable, testable & encapsulated view components
   in Ruby on Rails.