view_component 4.0.0.alpha7 → 4.0.0.rc2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8be3a213c479ad3bc1cb82fad0a04b6b9a3f424a4995e0162e447c50cd6b0ef9
-  data.tar.gz: a7744949cc46b57628a55e78bb0bd766f048f140c8ca1769c271032e9d648176
+  metadata.gz: cfdffe5b162240d97c986ddbdee4f537e04bddebde4f622a573c691599a73bed
+  data.tar.gz: d98395c2fe7910511a22da7a42864fa9a3c7c47c3a865be52defd3e54ad0b7c7
 SHA512:
-  metadata.gz: 13776ebd6447652ce0ad682a40bc70a4141b6b2db8690c32d7191828adbe9fd16ec8d30775007b29ff4c71bc559317cc56b60c94ab2af67ef4d259ea89ec3220
-  data.tar.gz: 2463587d1336f2b30e17e51f728526157c27752adb66bbc3703d20b68326d20eb734ee2990c7583866723ba3d927564d22ea6ddd9c0a70e515264043ce1d08d6
+  metadata.gz: b8a6d36f48196994b26af63743dd1f9cbf9cf3bd71cd656e2de9b6f34a8fb69c5620e348dd9b791c1d59864627f6d0dc1fb7d56e50ad5e1a1376c611bd555864
+  data.tar.gz: ec1366449379c2817bc18e8c8fd565e0aee7a564c99a5c6c564d8da5ee2f60ae5582c1d46fbef25af532fc2e96a5c9b1de5d5e0907850c3af78b394ca49b772d

data/docs/CHANGELOG.md

@@ -10,6 +10,87 @@ nav_order: 6
 
 ## main
 
+## 4.0.0.rc2
+
+* Add `around_render` lifecyle method for wrapping component rendering in custom instrumentation, etc.
+
+    *Joel Hawksley*, *Blake Williams*
+
+## 4.0.0.rc1
+
+Almost six years after releasing [v1.0.0](https://github.com/ViewComponent/view_component/releases/tag/v1.0.0), we're proud to ship the first release candidate of 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.
+
+Please report any issues at [https://github.com/ViewComponent/view_component/issues](https://github.com/ViewComponent/view_component/issues).
+
+### Breaking changes (production)
+
+* Remove dependency on `ActionView::Base`, eliminating the need for capture compatibility patch. In some edge cases, this change may require switching to use the `helpers.` proxy.
+* Require [non-EOL](https://endoflife.date/rails) Rails (`>= 7.1.0`) and Ruby (`>= 3.2.0`).
+* Remove `render_component` and `render` monkey patch configured with `render_monkey_patch_enabled`.
+* Remove deprecated `use_helper(s)`. Use `include MyHelper` or `helpers.` proxy instead.
+* Support compatibility with `Dry::Initializer`. As a result, `EmptyOrInvalidInitializerError` will no longer be raised.
+* Remove default initializer from `ViewComponent::Base`. Previously, `ViewComponent::Base` defined a catch-all initializer that allowed components without an initializer defined to be passed arbitrary arguments.
+* Remove `use_deprecated_instrumentation_name` configuration option. Events will always use `render.view_component` name.
+* Remove unnecessary `#format` methods that returned `nil`.
+* Remove support for variant names containing `.` to be consistent with Rails.
+* Rename internal methods to have `__vc_` prefix if they shouldn't be used by consumers. Make internal constants private. Make `Collection#components`, `Slotable#register_polymorphic_slot` private. Remove unused `ComponentError` class.
+* Use ActionView's `lookup_context` for picking templates instead of the request format.
+
+  3.15 added support for using templates that match the request format, that is if `/resource.csv` is requested then
+  ViewComponents would pick `_component.csv.erb` over `_component.html.erb`.
+
+  With this release, the request format is no longer considered and instead ViewComponent will use the Rails logic for picking the most appropriate template type, that is the csv template will be used if it matches the `Accept` header or because the controller uses a `respond_to` block to pick the response format.
+
+### 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.
+* 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.
+* Use `Nokogiri::HTML5` instead of `Nokogiri::HTML4` for test helpers.
+* Move generators to a ViewComponent namespace.
+
+  Before, ViewComponent generators pollute the generator namespace with a bunch of top level items, and claim the generic "component" name.
+
+  Now, generators live in a "view_component" module/namespace, so what was before `rails g
+  component` is now `rails g view_component:component`.
+
+### New features
+
+* Add `SystemSpecHelpers` for use with RSpec.
+* Add support for including `Turbo::StreamsHelper`.
+* Add template annotations for components with `def call`.
+* Graduate `SlotableDefault` to be included by default.
+* Add `#current_template` accessor and `Template#path` for diagnostic usage.
+* Reduce string allocations during compilation.
+
+### 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 response format wasn't set, which caused issues with Turbo Frames.
+* 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
+
+### Non-functional changes
+
+* Remove unnecessary usage of `ruby2_keywords`.
+* Remove unnecessary `respond_to` checks.
+* Require MFA when publishing to RubyGems.
+* Clean up project dependencies, relaxing versions of development gems.
+* Add test case for absolute URL path helpers in mailers.
+* 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.
+* Add test coverage for uncovered code.
+* Test against `turbo-rails` `v2` and `rspec-rails` `v7`.
+
 ## 4.0.0.alpha7
 
 * BREAKING: Remove deprecated `use_helper(s)`. Use `include MyHelper` or `helpers.` proxy instead.
@@ -24,7 +105,7 @@ nav_order: 6
 
     *Joel Hawksley*
 
-* Fix bug where `config.previews.enabled` did not function properly in production environments.
+* Fix bug where `config.previews.enabled` didn't function properly in production environments.
 
     *Joel Hawksley*
 
@@ -159,11 +240,11 @@ This release makes the following breaking changes:
 
 * BREAKING: Use ActionView's `lookup_context` for picking templates instead of the request format.
 
-  3.15 added support for using templates that match the request format, i.e. if `/resource.csv` is requested then
+  3.15 added support for using templates that match the request format, that is if `/resource.csv` is requested then
   ViewComponents would pick `_component.csv.erb` over `_component.html.erb`.
 
   With this release, the request format is no longer considered and instead ViewComponent will use the Rails logic
-  for picking the most appropriate template type, i.e. the csv template will be used if it matches the `Accept` header
+  for picking the most appropriate template type, that is the csv template will be used if it matches the `Accept` header
   or because the controller uses a `respond_to` block to pick the response format.
 
     *Stephen Nelson*
@@ -172,11 +253,11 @@ This release makes the following breaking changes:
 
     *Joel Hawksley*
 
-* Fix bug where request-aware helpers did not work outside of the request context.
+* Fix bug where request-aware helpers didn't work outside of the request context.
 
     *Joel Hawksley*, *Stephen Nelson*
 
-* `ViewComponentsSystemTestController` should not be useable outside of test environment
+* `ViewComponentsSystemTestController` shouldn't be useable outside of test environment
 
     *Joel Hawksley*, *Stephen Nelson*
 

data/lib/view_component/base.rb

@@ -108,6 +108,7 @@ module ViewComponent
       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,7 +141,12 @@ module ViewComponent
         value = nil
 
         @output_buffer.with_buffer do
-          rendered_template = render_template_for(@__vc_requested_details).to_s
+          @view_context.instance_variable_set(:@virtual_path, virtual_path)
+
+          rendered_template =
+            around_render do
+              render_template_for(@__vc_requested_details).to_s
+            end
 
           # Avoid allocating new string when output_preamble and output_postamble are blank
           value = if output_preamble.blank? && output_postamble.blank?
@@ -160,6 +166,7 @@ module ViewComponent
         ""
       end
     ensure
+      view_context.instance_variable_set(:@virtual_path, old_virtual_path)
       @current_template = old_current_template
     end
 
@@ -224,6 +231,14 @@ module ViewComponent
       # noop
     end
 
+    # Called around rendering the component. Override to wrap the rendering of a
+    # component in custom instrumentation, etc.
+    #
+    # @return [void]
+    def around_render
+      yield
+    end
+
     # Override to determine whether the ViewComponent should render.
     #
     # @return [Boolean]

data/lib/view_component/system_spec_helpers.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module SystemSpecHelpers
+    include SystemTestHelpers
+
+    def page
+      Capybara.current_session
+    end
+  end
+end

data/lib/view_component/template.rb

@@ -98,9 +98,8 @@ module ViewComponent
       @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

data/lib/view_component/version.rb

@@ -5,7 +5,7 @@ module ViewComponent
     MAJOR = 4
     MINOR = 0
     PATCH = 0
-    PRE = "alpha7"
+    PRE = "rc2"
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
   end

data/lib/view_component.rb

@@ -18,6 +18,7 @@ module ViewComponent
 
   if Rails.env.test?
     autoload :TestHelpers
+    autoload :SystemSpecHelpers
     autoload :SystemTestHelpers
     autoload :TestCase
     autoload :SystemTestCase

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 4.0.0.alpha7
+  version: 4.0.0.rc2
 platform: ruby
 authors:
 - ViewComponent Team
@@ -75,6 +75,7 @@ files:
 - lib/view_component/request_details.rb
 - lib/view_component/slot.rb
 - lib/view_component/slotable.rb
+- lib/view_component/system_spec_helpers.rb
 - lib/view_component/system_test_case.rb
 - lib/view_component/system_test_helpers.rb
 - lib/view_component/template.rb
@@ -88,6 +89,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
+  rubygems_mfa_required: 'true'
   source_code_uri: https://github.com/viewcomponent/view_component
   changelog_uri: https://github.com/ViewComponent/view_component/blob/main/docs/CHANGELOG.md
 rdoc_options: []