view_component 4.0.0.rc4 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3d836f60a33d5a66087281b9edbb578a118d706721160676173390a8eab5d361
-  data.tar.gz: 9c6129650fbc464da3e315244eba6a893d5722dc9e577673efb0f3b090279386
+  metadata.gz: 315f6566baf49a86b15ce8537b28995fa64c8623c1a541c4cf2bc85891c5f837
+  data.tar.gz: ba7b833f7a0714e076cfc4e343c20532a2cba5737582aa654f143971c8c7a9f1
 SHA512:
-  metadata.gz: 46da774d6dd963153254af7e11ce5d03891d69c302e48220b5e7f54795ebdb58ca93d09af9975c47076bb58a13f379df60fafff04b597b5236bd77c3e2d122c2
-  data.tar.gz: a4038c0360c90b2958ce31b31bd50260d6e10964e15733de9c2a7b57488ddaaa0773d583da2efdbe81c7aaae340ad1f8324f00283dac5bd3db69588befb1b76d
+  metadata.gz: 2d7903db688c6c28a3a2a874f2480ec70328b05e081629b6f0fe1f59ae1b049cea41e127ac89de098b256d00a6c1cd20c21b76d2ec04345c550132368dada341
+  data.tar.gz: 1d6ad41497fbb4a4f7fb1a44fbd606897e6e6b88f48933f818b26461834fe414c0c3f840f85fefedf6ed39f206fd07786c8e597a473ef44bdaacecfbb548e43d

data/docs/CHANGELOG.md

@@ -10,6 +10,95 @@ nav_order: 6
 
 ## main
 
+## 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.
+
+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.
+* Add `around_render` lifecyle method for wrapping component rendering in custom instrumentation, etc.
+
+### 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 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.rc5
+
+* Revert change setting `#format`. In GitHub's codebase, the change led to hard-to-detect failures. For example, components rendered from controllers included layouts when they didn't before. In other cases, the response `content_type` changed, breaking downstream consumers. For cases where a specific content type is needed, use:
+
+```ruby
+respond_to do |f|
+  f.html_fragment do
+    render(MyComponent.new)
+  end
+end
+```
+
+    *Joel Hawksley*
+
 ## 4.0.0.rc4
 
 * Fix issue where generators were not included in published gem.
@@ -42,7 +131,7 @@ Almost six years after releasing [v1.0.0](https://github.com/ViewComponent/view_
 
 Please report any issues at [https://github.com/ViewComponent/view_component/issues](https://github.com/ViewComponent/view_component/issues).
 
-### Breaking changes (production)
+### 4.0.0.rc1 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`).
@@ -61,7 +150,7 @@ Please report any issues at [https://github.com/ViewComponent/view_component/iss
 
   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)
+### 4.0.0.rc1 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.
@@ -79,7 +168,7 @@ Please report any issues at [https://github.com/ViewComponent/view_component/iss
   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
+### 4.0.0.rc1 New features
 
 * Add `SystemSpecHelpers` for use with RSpec.
 * Add support for including `Turbo::StreamsHelper`.
@@ -88,7 +177,7 @@ Please report any issues at [https://github.com/ViewComponent/view_component/iss
 * Add `#current_template` accessor and `Template#path` for diagnostic usage.
 * Reduce string allocations during compilation.
 
-### Bug fixes
+### 4.0.0.rc1 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.
@@ -97,7 +186,7 @@ Please report any issues at [https://github.com/ViewComponent/view_component/iss
 * 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
+### 4.0.0.rc1 Non-functional changes
 
 * Remove unnecessary usage of `ruby2_keywords`.
 * Remove unnecessary `respond_to` checks.

data/lib/view_component/base.rb

@@ -71,8 +71,6 @@ module ViewComponent
     # Config option that strips trailing whitespace in templates before compiling them.
     class_attribute :__vc_strip_trailing_whitespace, instance_accessor: false, instance_predicate: false, default: false
 
-    class_attribute :__vc_response_format, instance_accessor: false, instance_predicate: false, default: nil
-
     attr_accessor :__vc_original_view_context
     attr_reader :current_template
 
@@ -356,10 +354,6 @@ module ViewComponent
       __vc_render_in_block_provided? || __vc_content_set_by_with_content_defined?
     end
 
-    def format
-      self.class.__vc_response_format
-    end
-
     # @private
     def with_original_virtual_path
       @view_context.instance_variable_set(:@virtual_path, @old_virtual_path)

data/lib/view_component/compiler.rb

@@ -48,15 +48,6 @@ module ViewComponent
 
         define_render_template_for
 
-        # Set the format if the component only responds to a single format.
-        # Unfortunately we cannot determine which format a multi-format
-        # component will respond to until render time, so those components
-        # will not set the response format.
-        #
-        # TODO: Investigate upstream changes necessary to support multi-format renderables
-        unique_formats = templates.map(&:format).uniq
-        @component.__vc_response_format = unique_formats.last if unique_formats.one?
-
         @component.__vc_register_default_slots
         @component.__vc_build_i18n_backend
 
@@ -118,7 +109,6 @@ module ViewComponent
         errors << "Couldn't find a template file or inline render method for #{@component}." if @templates.empty?
 
         @templates
-          .reject { |template| template.inline_call? && !template.defined_on_self? }
           .map { |template| [template.variant, template.format] }
           .tally
           .select { |_, count| count > 1 }

data/lib/view_component/template.rb

@@ -43,7 +43,7 @@ module ViewComponent
       attr_reader :source
 
       def initialize(component:, inline_template:)
-        details = ActionView::TemplateDetails.new(nil, inline_template.language.to_sym, DEFAULT_FORMAT, nil)
+        details = ActionView::TemplateDetails.new(nil, inline_template.language.to_sym, nil, nil)
 
         super(
           component: component,
@@ -63,7 +63,7 @@ module ViewComponent
     class InlineCall < Template
       def initialize(component:, method_name:, defined_on_self:)
         variant = method_name.to_s.include?("call_") ? method_name.to_s.sub("call_", "").to_sym : nil
-        details = ActionView::TemplateDetails.new(nil, nil, DEFAULT_FORMAT, variant)
+        details = ActionView::TemplateDetails.new(nil, nil, nil, variant)
 
         super(component: component, details: details)
 

data/lib/view_component/version.rb

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

metadata

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