view_component 2.74.1 → 2.82.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 64dcea99274ed75352d28004634307fa7db193aa5bf8bf57dd0c9d5c5c241308
-  data.tar.gz: c097b1034bc3df6216117fc0b32df26a8b02c0922c7e7399b254a6606aa46c31
+  metadata.gz: 9bb20706245c43b9c5fa4d11087a2e98332bda53d659f7065874a3c0b8545547
+  data.tar.gz: 13821a1e91da8a8dce8270962b99aa3b84fddb9731f99c2e2acfd143ad017836
 SHA512:
-  metadata.gz: efe5f3a05e157482eec4426ae05eef96345da9aa3ae0865c2ce7bc1755e08ae07405ee648923fe84165eca989a87b53f015012f13002202e809c12819c552a5b
-  data.tar.gz: 7b8bb21b81a1da222b47dd8c8c12cf2c0f7f5e2bd1e74d80ebfc8bf7e1cbe5c54eeab46c80395d3c8bb28809caac8be07ce833e1530af3b982d153d44398fba2
+  metadata.gz: 5b0ebf7ac54fc2c82374b29f9cceadfe55af73516ad2e4c65dad69cd65a7c63de3e00ef9cdba8b359c1061309f9a0d2f90344374feec2b37211fbfb36282c96b
+  data.tar.gz: 48e156dcc5fa1ac9a6cff64e4cb585d528103452938a515d1e3598b505b03188e89362c393c86c0a05437f9a8c28f22e937e3d706f3da17ae03a7c1371728505

data/app/controllers/view_components_system_test_controller.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class ViewComponentsSystemTestController < ActionController::Base # :nodoc:
+  def system_test_entrypoint
+    render file: "./tmp/view_components/#{params.permit(:file)[:file]}"
+  end
+end

data/docs/CHANGELOG.md

@@ -10,6 +10,124 @@ nav_order: 5
 
 ## main
 
+## 2.82.0
+
+* Revert "Avoid loading ActionView::Base during initialization (#1528)"
+
+    *Jon Rohan*
+
+* Fix tests using `with_rendered_component_path` with custom layouts.
+
+    *Ian Hollander*
+
+## 2.81.0
+
+* Adjust the way response objects are set on the preview controller to work around a recent change in Rails main.
+
+    *Cameron Dutro*
+
+* Fix typo in "Generate a Stimulus controller" documentation.
+
+    *Ben Trewern*
+
+* Modify the `render_in_view_context` test helper to forward its args to the block.
+
+    *Cameron Dutro*
+
+## 2.80.0
+
+* Move system test endpoint out of the unrelated previews controller.
+
+    *Edwin Mak*
+
+* Display Ruby 2.7 deprecation notice only once, when starting the application.
+
+    *Henrik Hauge Bjørnskov*
+
+* Require Rails 5.2+ in gemspec and update documentation.
+
+    *Drew Bragg*
+
+* Add documentation for using `with_rendered_component_path` with RSpec.
+
+    *Edwin Mak*
+
+## 2.79.0
+
+* Add ability to pass explicit `preview_path` to preview generator.
+
+    *Erinna Chen*
+
+* Add `with_rendered_component_path` helper for writing component system tests.
+
+    *Edwin Mak*
+
+* Include gem name and deprecation horizon in every deprecation message.
+
+    *Jan Klimo*
+
+## 2.78.0
+
+* Support variants with dots in their names.
+
+    *Javi Martín*
+
+## 2.77.0
+
+* Support variants with dashes in their names.
+
+    *Javi Martín*
+
+## 2.76.0
+
+* `Component.with_collection` supports components that accept splatted keyword arguments.
+
+    *Zee Spencer*
+
+* Remove `config.view_component.use_consistent_rendering_lifecycle` since it is no longer planned for 3.0.
+
+    *Blake Williams*
+
+* Prevent polymorphic slots from calculating `content` when setting a slot.
+
+    *Blake Williams*
+
+* Add ability to pass in the preview class to `render_preview`.
+
+    *Jon Rohan*
+
+* Fix issue causing PVC tests to fail in CI.
+
+    *Cameron Dutro*
+
+* Fix YARD docs build task.
+
+    *Hans Lemuet*
+
+* Add Startup Jobs to list of companies using ViewComponent.
+
+    *Marc Köhlbrugge*
+
+* Run PVC's accessibility tests in a single process to avoid resource contention in CI.
+
+    *Cameron Dutro*
+
+## 2.75.0
+
+* Avoid loading ActionView::Base during Rails initialization.
+
+    *Jonathan del Strother*
+
+<!-- vale off -->
+* Mention lambda slots rendering returned values lazily in the guide.
+
+    *Graham Rogers*
+<!-- vale on -->
+
+* Add "ViewComponent In The Wild" articles to resources.
+
+    *Alexander Baygeldin*
+
 ## 2.74.1
 
 * Add more users of ViewComponent to docs.
@@ -273,7 +391,7 @@ nav_order: 5
 
 * Revert `Expose Capybara DSL methods directly inside tests.` This change unintentionally broke other Capybara methods and thus introduced a regression. We aren't confident that we can fail forward so we have decided to revert this change.
 
-    *Joel Hawksley*, *Blake Williams*
+    *Joel Hawksley, Blake Williams*
 
 * Revert change making content evaluation consistent.
 
@@ -356,7 +474,7 @@ nav_order: 5
 
 * Add @boardfish and @spone as maintainers.
 
-    *Joel Hawksley*, *Cameron Dutro*, *Blake Williams*
+    *Joel Hawksley, Cameron Dutro, Blake Williams*
 
 * Re-compile updated, inherited templates when class caching is disabled.
 
@@ -416,13 +534,13 @@ nav_order: 5
 
 * Restore removed `rendered_component`, marking it for deprecation in v3.0.0.
 
-    *Tyson Gach*, *Richard Macklin*, *Joel Hawksley*
+    *Tyson Gach, Richard Macklin, Joel Hawksley*
 
 ## 2.56.1
 
 * Rename private accessor `rendered_component` to `rendered_content`.
 
-    *Yoshiyuki Hirano*, *Simon Dawson*
+    *Yoshiyuki Hirano, Simon Dawson*
 
 ## 2.56.0
 
@@ -513,7 +631,7 @@ nav_order: 5
 
 * Skip Rails 5.2 in local test environment if using incompatible Ruby version.
 
-    *Cameron Dutro*, *Blake Williams*, *Joel Hawksley*
+    *Cameron Dutro, Blake Williams, Joel Hawksley*
 
 * Improve landing page documentation.
 
@@ -539,7 +657,7 @@ nav_order: 5
 
 * Add the option to use a "global" output buffer so `form_for` and friends can be used with view components.
 
-    *Cameron Dutro*, *Blake Williams*
+    *Cameron Dutro, Blake Williams*
 
 * Fix fragment caching in partials when global output buffer is enabled.
 * Fix template inheritance when eager loading is disabled.
@@ -676,7 +794,7 @@ nav_order: 5
 
 * Add generators to support `tailwindcss-rails`.
 
-    *Dino Maric*, *Hans Lemuet*
+    *Dino Maric, Hans Lemuet*
 
 * Add a namespaced component example to docs.
 
@@ -857,7 +975,7 @@ nav_order: 5
 
 * Rename internal accessor to use private naming.
 
-    *Joel Hawksley*, *Blake Williams*, *Cameron Dutro*
+    *Joel Hawksley, Blake Williams, Cameron Dutro*
 
 * Add Github repo link to docs website header.
 
@@ -925,7 +1043,7 @@ nav_order: 5
 
 * Add support for `image_path` helper in previews.
 
-    *Tobias Ahlin*, *Joel Hawksley*
+    *Tobias Ahlin, Joel Hawksley*
 
 * Add section to docs listing users of ViewComponent. Please submit a PR to add your team to the list!
 
@@ -963,7 +1081,7 @@ nav_order: 5
 
 * Fix bug where `helpers` would instantiate and use a new `view_context` in each component.
 
-    *Blake Williams*, *Ian C. Anderson*
+    *Blake Williams, Ian C. Anderson*
 
 * Implement polymorphic slots as experimental feature. See the Slots documentation to learn more.
 
@@ -990,7 +1108,7 @@ nav_order: 5
 
 * Fix bug where `with_collection_parameter` didn't inherit from parent component.
 
-    *Will Drexler*, *Christian Campoli*
+    *Will Drexler, Christian Campoli*
 
 * Allow query parameters in `with_request_url` test helper.
 
@@ -1030,7 +1148,7 @@ nav_order: 5
 
 * Clarify documentation of `with_variant` as an override of Action Pack.
 
-    *Blake Williams*, *Cameron Dutro*, *Joel Hawksley*
+    *Blake Williams, Cameron Dutro, Joel Hawksley*
 
 * Update docs page to be called Javascript and CSS, rename Building ViewComponents to Guide.
 
@@ -1055,7 +1173,7 @@ nav_order: 5
 
 * Clarify slots example in docs to reduce naming confusion.
 
-    *Joel Hawksley*, *Blake Williams*
+    *Joel Hawksley, Blake Williams*
 
 * Fix error in documentation for `render_many` passthrough slots.
 
@@ -1517,7 +1635,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 * Add support for templates as ViewComponent::Preview examples.
 
-    *Juan Manuel Ramallo
+    *Juan Manuel Ramallo*
 
 ## 2.14.1
 
@@ -1894,11 +2012,11 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
     *Rainer Borene*
 
+<!-- vale off -->
 * Fix edge case issue with extracting variants from less conventional source_locations.
 
-<!-- vale proselint.GenderBias = NO -->
     *Ryan Workman*
-<!-- vale proselint.GenderBias = YES -->
+<!-- vale on -->
 
 ## v1.6.0
 
@@ -1916,7 +2034,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 * Template-less variants fall back to default template.
 
-    *Asger Behncke Jacobsen*, *Cesario Uy*
+    *Asger Behncke Jacobsen, Cesario Uy*
 
 * Generated tests use new naming convention.
 
@@ -1932,11 +2050,11 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## v1.5.3
 
+<!-- vale off -->
 * Add support for RSpec to generators.
 
-<!-- vale proselint.GenderBias = NO -->
     *Dylan Clark, Ryan Workman*
-<!-- vale proselint.GenderBias = YES -->
+<!-- vale on -->
 
 * Require controllers as part of setting autoload paths.
 
@@ -1958,11 +2076,11 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 Note: `actionview-component` is now loaded by requiring `actionview/component`, not `actionview/component/base`.
 
+<!-- vale off -->
 * Fix issue with generating component method signatures.
 
-<!-- vale proselint.GenderBias = NO -->
     *Ryan Workman, Dylan Clark*
-<!-- vale proselint.GenderBias = YES -->
+<!-- vale off -->
 
 * Create component generator.
 

data/lib/rails/generators/preview/component_generator.rb

@@ -4,15 +4,22 @@ module Preview
   module Generators
     class ComponentGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path("templates", __dir__)
+      class_option :preview_path, type: :string, desc: "Path for previews, required when multiple preview paths are configured", default: ViewComponent::Base.config.generate.preview_path
 
       argument :attributes, type: :array, default: [], banner: "attribute"
       check_class_collision suffix: "ComponentPreview"
 
       def create_preview_file
         preview_paths = ViewComponent::Base.config.preview_paths
-        return if preview_paths.count > 1
+        optional_path = options[:preview_path]
+        return if preview_paths.count > 1 && optional_path.blank?
+
+        path_prefix = if optional_path.present?
+          optional_path
+        else
+          preview_paths.one? ? preview_paths.first : "test/components/previews"
+        end
 
-        path_prefix = preview_paths.one? ? preview_paths.first : "test/components/previews"
         template "component_preview.rb", File.join(path_prefix, class_path, "#{file_name}_component_preview.rb")
       end
 

data/lib/view_component/base.rb

@@ -19,9 +19,16 @@ module ViewComponent
     class << self
       delegate(*ViewComponent::Config.defaults.keys, to: :config)
 
+      # Returns the current config.
+      #
+      # @return [ViewComponent::Config]
       def config
         @config ||= ViewComponent::Config.defaults
       end
+
+      # Replaces the entire config. You shouldn't need to use this directly
+      # unless you're building a `ViewComponent::Config` elsewhere.
+      attr_writer :config
     end
 
     include ViewComponent::ContentAreas
@@ -123,11 +130,6 @@ module ViewComponent
       before_render
 
       if render?
-        # Ensure `content` is evaluated before rendering the template, this is
-        # needed so slots and other side-effects are performed before the
-        # component template is evaluated.
-        content if self.class.use_consistent_rendering_lifecycle
-
         render_template_for(@__vc_variant).to_s + output_postamble
       else
         ""
@@ -333,18 +335,6 @@ module ViewComponent
     # Defaults to `nil`. If this is falsy, `app/components` is used.
     #
 
-    # Evaluate `#content` before `#call` to ensure side-effects are present
-    # during component renders. This will be the default behavior in a future
-    # release.
-    #
-    # ```ruby
-    # config.view_component.use_consistent_rendering_lifecycle = true
-    # ```
-    #
-    # Defaults to `false`
-    #
-    mattr_accessor :use_consistent_rendering_lifecycle, instance_writer: false, default: false
-
     # Parent class for generated components
     #
     # ```ruby
@@ -412,7 +402,7 @@ module ViewComponent
       # Find sidecar files for the given extensions.
       #
       # The provided array of extensions is expected to contain
-      # strings starting without the "dot", example: `["erb", "haml"]`.
+      # strings starting without the dot, example: `["erb", "haml"]`.
       #
       # For example, one might collect sidecar CSS files that need to be compiled.
       # @param extensions [Array<String>] Extensions of which to return matching sidecar files.
@@ -590,7 +580,7 @@ module ViewComponent
         parameter = validate_default ? collection_parameter : provided_collection_parameter
 
         return unless parameter
-        return if initialize_parameter_names.include?(parameter)
+        return if initialize_parameter_names.include?(parameter) || splatted_keyword_argument_present?
 
         # If Ruby can't parse the component class, then the initalize
         # parameters will be empty and ViewComponent will not be able to render
@@ -646,6 +636,11 @@ module ViewComponent
 
       private
 
+      def splatted_keyword_argument_present?
+        initialize_parameters.flatten.include?(:keyrest) &&
+          !initialize_parameters.include?([:keyrest, :**]) # Un-named splatted keyword args don't count!
+      end
+
       def initialize_parameter_names
         return attribute_names.map(&:to_sym) if respond_to?(:attribute_names)
 

data/lib/view_component/compiler.rb

@@ -30,10 +30,6 @@ module ViewComponent
       return if compiled? && !force
       return if component_class == ViewComponent::Base
 
-      if RUBY_VERSION < "2.7.0"
-        ViewComponent::Deprecation.warn("Support for Ruby versions < 2.7.0 will be removed in v3.0.0.")
-      end
-
       component_class.superclass.compile(raise_errors: raise_errors) if should_compile_superclass?
       subclass_instance_methods = component_class.instance_methods(false)
 
@@ -51,9 +47,8 @@ module ViewComponent
       end
 
       if subclass_instance_methods.include?(:before_render_check)
-        ViewComponent::Deprecation.warn(
-          "`#before_render_check` will be removed in v3.0.0.\n\n" \
-          "To fix this issue, use `#before_render` instead."
+        ViewComponent::Deprecation.deprecation_warning(
+          "`before_render_check`", :"`before_render`"
         )
       end
 
@@ -92,7 +87,7 @@ module ViewComponent
 
     def define_render_template_for
       variant_elsifs = variants.compact.uniq.map do |variant|
-        "elsif variant.to_sym == :#{variant}\n    #{call_method_name(variant)}"
+        "elsif variant.to_sym == :'#{variant}'\n    #{call_method_name(variant)}"
       end.join("\n")
 
       body = <<-RUBY
@@ -163,6 +158,19 @@ module ViewComponent
               "There can only be a template file or inline render method per variant."
           end
 
+          uniq_variants = variants.compact.uniq
+          normalized_variants = uniq_variants.map { |variant| normalized_variant_name(variant) }
+
+          colliding_variants = uniq_variants.select do |variant|
+            normalized_variants.count(normalized_variant_name(variant)) > 1
+          end
+
+          unless colliding_variants.empty?
+            errors <<
+              "Colliding templates #{colliding_variants.sort.map { |v| "'#{v}'" }.to_sentence} " \
+              "found in #{component_class}."
+          end
+
           errors
         end
     end
@@ -176,7 +184,7 @@ module ViewComponent
             pieces = File.basename(path).split(".")
             memo << {
               path: path,
-              variant: pieces.second.split("+").second&.to_sym,
+              variant: pieces[1..-2].join(".").split("+").second&.to_sym,
               handler: pieces.last
             }
           end
@@ -234,12 +242,16 @@ module ViewComponent
 
     def call_method_name(variant)
       if variant.present? && variants.include?(variant)
-        "call_#{variant}"
+        "call_#{normalized_variant_name(variant)}"
       else
         "call"
       end
     end
 
+    def normalized_variant_name(variant)
+      variant.to_s.gsub("-", "__").gsub(".", "___")
+    end
+
     def should_compile_superclass?
       development? &&
         templates.empty? &&

data/lib/view_component/config.rb

@@ -12,7 +12,7 @@ module ViewComponent
 
       def defaults
         ActiveSupport::OrderedOptions.new.merge!({
-          generate: ActiveSupport::OrderedOptions.new(false),
+          generate: default_generate_options,
           preview_controller: "ViewComponentsController",
           preview_route: "/rails/view_components",
           show_previews_source: false,
@@ -34,25 +34,25 @@ module ViewComponent
       # All options under this namespace default to `false` unless otherwise
       # stated.
       #
-      # #### #sidecar
+      # #### `#sidecar`
       #
       # Always generate a component with a sidecar directory:
       #
       #     config.view_component.generate.sidecar = true
       #
-      # #### #stimulus_controller
+      # #### `#stimulus_controller`
       #
       # Always generate a Stimulus controller alongside the component:
       #
       #     config.view_component.generate.stimulus_controller = true
       #
-      # #### #locale
+      # #### `#locale`
       #
       # Always generate translations file alongside the component:
       #
       #     config.view_component.generate.locale = true
       #
-      # #### #distinct_locale_files
+      # #### `#distinct_locale_files`
       #
       # Always generate as many translations files as available locales:
       #
@@ -61,11 +61,22 @@ module ViewComponent
       # One file will be generated for each configured `I18n.available_locales`,
       # falling back to `[:en]` when no `available_locales` is defined.
       #
-      # #### #preview
+      # #### `#preview`
       #
       # Always generate a preview alongside the component:
       #
       #      config.view_component.generate.preview = true
+      #
+      # #### #preview_path
+      #
+      # Path to generate preview:
+      #
+      #      config.view_component.generate.preview_path = "test/components/previews"
+      #
+      # Required when there is more than one path defined in preview_paths.
+      # Defaults to `""`. If this is blank, the generator will use
+      # `ViewComponent.config.preview_paths` if defined,
+      # `"test/components/previews"` otherwise
 
       # @!attribute preview_controller
       # @return [String]
@@ -135,6 +146,12 @@ module ViewComponent
 
         ["#{Rails.root}/test/components/previews"]
       end
+
+      def default_generate_options
+        options = ActiveSupport::OrderedOptions.new(false)
+        options.preview_path = ""
+        options
+      end
     end
 
     def initialize
@@ -146,7 +163,7 @@ module ViewComponent
     end
 
     def preview_path=(new_value)
-      ViewComponent::Deprecation.warn("`preview_path` will be removed in v3.0.0. Use `preview_paths` instead.")
+      ViewComponent::Deprecation.deprecation_warning("`preview_path`", :"`preview_paths`")
       self.preview_paths = Array.wrap(new_value)
     end
 

data/lib/view_component/content_areas.rb

@@ -31,9 +31,8 @@ module ViewComponent
 
     class_methods do
       def with_content_areas(*areas)
-        ViewComponent::Deprecation.warn(
-          "`with_content_areas` is deprecated and will be removed in ViewComponent v3.0.0.\n\n" \
-          "Use slots (https://viewcomponent.org/guide/slots.html) instead."
+        ViewComponent::Deprecation.deprecation_warning(
+          "`with_content_areas`", "use slots (https://viewcomponent.org/guide/slots.html) instead"
         )
 
         if areas.include?(:content)

data/lib/view_component/deprecation.rb

@@ -3,6 +3,6 @@
 require "active_support/deprecation"
 
 module ViewComponent
-  DEPRECATION_HORIZON = 3
-  Deprecation = ActiveSupport::Deprecation.new(DEPRECATION_HORIZON.to_s, "ViewComponent")
+  DEPRECATION_HORIZON = "3.0.0"
+  Deprecation = ActiveSupport::Deprecation.new(DEPRECATION_HORIZON, "ViewComponent")
 end

data/lib/view_component/docs_builder_component.html.erb

@@ -1,6 +1,6 @@
 ---
 layout: default
-title: API
+title: API reference
 nav_order: 3
 ---
 

data/lib/view_component/docs_builder_component.rb

@@ -57,7 +57,7 @@ module ViewComponent
 
       def call
         <<~DOCS.chomp
-          #{separator}#{signature_or_name}#{types}#{suffix}
+          `#{separator}#{signature_or_name}`#{types}#{suffix}
 
           #{docstring_and_deprecation_text}
         DOCS

data/lib/view_component/engine.rb

@@ -131,6 +131,12 @@ module ViewComponent
         end
       end
 
+      if Rails.env.test?
+        app.routes.prepend do
+          get("_system_test_entrypoint", to: "view_components_system_test#system_test_entrypoint")
+        end
+      end
+
       app.executor.to_run :before do
         CompileCache.invalidate! unless ActionView::Base.cache_template_loading
       end
@@ -138,13 +144,17 @@ module ViewComponent
   end
 end
 
+if RUBY_VERSION < "2.7.0"
+  ViewComponent::Deprecation.deprecation_warning("Support for Ruby versions < 2.7.0")
+end
+
 # :nocov:
 unless defined?(ViewComponent::Base)
   require "view_component/deprecation"
 
-  ViewComponent::Deprecation.warn(
-    "This manually engine loading is deprecated and will be removed in v3.0.0. " \
-    'Remove `require "view_component/engine"`.'
+  ViewComponent::Deprecation.deprecation_warning(
+    "Manually loading the engine",
+    "remove `require \"view_component/engine\"`"
   )
 
   require "view_component"

data/lib/view_component/polymorphic_slots.rb

@@ -62,9 +62,9 @@ module ViewComponent
 
           define_method(setter_name) do |*args, &block|
             if _warn_on_deprecated_slot_setter
-              ViewComponent::Deprecation.warn(
-                "polymorphic slot setters like `#{setter_name}` are deprecated and will be removed in " \
-                "ViewComponent v3.0.0.\n\nUse `with_#{setter_name}` instead."
+              ViewComponent::Deprecation.deprecation_warning(
+                "Using polymorphic slot setters like `#{setter_name}`",
+                :"`with_#{setter_name}`"
               )
             end
 
@@ -89,7 +89,7 @@ module ViewComponent
       def set_polymorphic_slot(slot_name, poly_type = nil, *args, &block)
         slot_definition = self.class.registered_slots[slot_name]
 
-        if !slot_definition[:collection] && get_slot(slot_name)
+        if !slot_definition[:collection] && (defined?(@__vc_set_slots) && @__vc_set_slots[slot_name])
           raise ArgumentError, "content for slot '#{slot_name}' has already been provided"
         end
 

data/lib/view_component/slotable.rb

@@ -23,9 +23,8 @@ module ViewComponent
       #   class_name: "Header" # class name string, used to instantiate Slot
       # )
       def with_slot(*slot_names, collection: false, class_name: nil)
-        ViewComponent::Deprecation.warn(
-          "`with_slot` is deprecated and will be removed in ViewComponent v3.0.0.\n" \
-          "Use the new slots API (https://viewcomponent.org/guide/slots.html) instead."
+        ViewComponent::Deprecation.deprecation_warning(
+          "`with_slot`", "use the new slots API (https://viewcomponent.org/guide/slots.html) instead"
         )
 
         slot_names.each do |slot_name|

data/lib/view_component/slotable_v2.rb

@@ -93,10 +93,12 @@ module ViewComponent
           else
             if _warn_on_deprecated_slot_setter
               stack = caller_locations(3)
-              msg = "Setting a slot with `##{slot_name}` is deprecated and will be removed in ViewComponent v3.0.0. " \
-                "Use `#with_#{slot_name}` to set the slot instead."
 
-              ViewComponent::Deprecation.warn(msg, stack)
+              ViewComponent::Deprecation.deprecation_warning(
+                "Setting a slot with `##{slot_name}`",
+                "use `#with_#{slot_name}` to set the slot instead",
+                stack
+              )
             end
 
             set_slot(slot_name, nil, *args, &block)
@@ -159,9 +161,9 @@ module ViewComponent
 
         define_method singular_name do |*args, &block|
           if _warn_on_deprecated_slot_setter
-            ViewComponent::Deprecation.warn(
-              "Setting a slot with `##{singular_name}` is deprecated and will be removed in ViewComponent v3.0.0. " \
-              "Use `#with_#{singular_name}` to set the slot instead."
+            ViewComponent::Deprecation.deprecation_warning(
+              "Setting a slot with `##{singular_name}`",
+              "use `#with_#{singular_name}` to set the slot instead"
             )
           end
 
@@ -187,9 +189,9 @@ module ViewComponent
             get_slot(slot_name)
           else
             if _warn_on_deprecated_slot_setter
-              ViewComponent::Deprecation.warn(
-                "Setting a slot with `##{slot_name}` is deprecated and will be removed in ViewComponent v3.0.0. " \
-                "Use `#with_#{slot_name}` to set the slot instead."
+              ViewComponent::Deprecation.deprecation_warning(
+                "Setting a slot with `##{slot_name}`",
+                "use `#with_#{slot_name}` to set the slot instead"
               )
             end
 

data/lib/view_component/system_test_case.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require "active_support/test_case"
+
+module ViewComponent
+  class SystemTestCase < ActionDispatch::SystemTestCase
+    include ViewComponent::SystemTestHelpers
+
+    def page
+      Capybara.current_session
+    end
+  end
+end

data/lib/view_component/system_test_helpers.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module SystemTestHelpers
+    include TestHelpers
+
+    #
+    # Returns a block that can be used to visit the path of the inline rendered component.
+    # @param fragment [Nokogiri::Fragment] The fragment returned from `render_inline`.
+    # @param layout [String] The (optional) layout to use.
+    # @return [Proc] A block that can be used to visit the path of the inline rendered component.
+    def with_rendered_component_path(fragment, layout: false, &block)
+      # Add './tmp/view_components/' directory if it doesn't exist to store the rendered component HTML
+      FileUtils.mkdir_p("./tmp/view_components/") unless Dir.exist?("./tmp/view_components/")
+
+      file = Tempfile.new(["rendered_#{fragment.class.name}", ".html"], "tmp/view_components/")
+      begin
+        file.write(controller.render_to_string(html: fragment.to_html.html_safe, layout: layout))
+        file.rewind
+
+        block.call("/_system_test_entrypoint?file=#{file.path.split("/").last}")
+      ensure
+        file.unlink
+      end
+    end
+  end
+end

data/lib/view_component/test_helpers.rb

@@ -35,10 +35,7 @@ module ViewComponent
     #
     # @return [String]
     def rendered_component
-      ViewComponent::Deprecation.warn(
-        "`rendered_component` is deprecated and will be removed in v3.0.0. " \
-        "Use `page` instead."
-      )
+      ViewComponent::Deprecation.deprecation_warning("`rendered_component`", :"`page`")
 
       rendered_content
     end
@@ -81,22 +78,10 @@ module ViewComponent
     # In RSpec, `Preview` is appended to `described_class`.
     #
     # @param name [String] The name of the preview to be rendered.
+    # @param from [ViewComponent::Preview] The class of the preview to be rendered.
     # @param params [Hash] Parameters to be passed to the preview.
     # @return [Nokogiri::HTML]
-    def render_preview(name, params: {})
-      begin
-        preview_klass = if respond_to?(:described_class)
-          raise "`render_preview` expected a described_class, but it is nil." if described_class.nil?
-
-          "#{described_class}Preview"
-        else
-          self.class.name.gsub("Test", "Preview")
-        end
-        preview_klass = preview_klass.constantize
-      rescue NameError
-        raise NameError, "`render_preview` expected to find #{preview_klass}, but it does not exist."
-      end
-
+    def render_preview(name, from: preview_class, params: {})
       previews_controller = build_controller(Rails.application.config.view_component.preview_controller.constantize)
 
       # From what I can tell, it's not possible to overwrite all request parameters
@@ -105,8 +90,8 @@ module ViewComponent
         previews_controller.request.params[k] = v
       end
 
-      previews_controller.request.params[:path] = "#{preview_klass.preview_name}/#{name}"
-      previews_controller.response = ActionDispatch::Response.new
+      previews_controller.request.params[:path] = "#{from.preview_name}/#{name}"
+      previews_controller.set_response!(ActionDispatch::Response.new)
       result = previews_controller.previews
 
       @rendered_content = result
@@ -114,21 +99,23 @@ module ViewComponent
       Nokogiri::HTML.fragment(@rendered_content)
     end
 
-    # Execute the given block in the view context. Internally sets `page` to be a
-    # `Capybara::Node::Simple`, allowing for Capybara assertions to be used:
+    # Execute the given block in the view context (using `instance_exec`).
+    # Internally sets `page` to be a `Capybara::Node::Simple`, allowing for
+    # Capybara assertions to be used. All arguments are forwarded to the block.
     #
     # ```ruby
-    # render_in_view_context do
-    #   render(MyComponent.new)
+    # render_in_view_context(arg1, arg2:) do |arg1, arg2:|
+    #   render(MyComponent.new(arg1, arg2))
     # end
     #
     # assert_text("Hello, World!")
     # ```
-    def render_in_view_context(&block)
+    def render_in_view_context(*args, &block)
       @page = nil
-      @rendered_content = controller.view_context.instance_exec(&block)
+      @rendered_content = controller.view_context.instance_exec(*args, &block)
       Nokogiri::HTML.fragment(@rendered_content)
     end
+    ruby2_keywords(:render_in_view_context) if respond_to?(:ruby2_keywords, true)
 
     # @private
     def controller
@@ -216,5 +203,20 @@ module ViewComponent
     def build_controller(klass)
       klass.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
     end
+
+    private
+
+    def preview_class
+      result = if respond_to?(:described_class)
+        raise "`render_preview` expected a described_class, but it is nil." if described_class.nil?
+
+        "#{described_class}Preview"
+      else
+        self.class.name.gsub("Test", "Preview")
+      end
+      result = result.constantize
+    rescue NameError
+      raise NameError, "`render_preview` expected to find #{result}, but it does not exist."
+    end
   end
 end

data/lib/view_component/version.rb

@@ -3,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 74
-    PATCH = 1
+    MINOR = 82
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

data/lib/view_component.rb

@@ -16,16 +16,18 @@ module ViewComponent
   autoload :Preview
   autoload :PreviewTemplateError
   autoload :TestHelpers
+  autoload :SystemTestHelpers
   autoload :TestCase
+  autoload :SystemTestCase
   autoload :TemplateError
   autoload :Translatable
 end
 
 # :nocov:
 if defined?(ViewComponent::Engine)
-  ViewComponent::Deprecation.warn(
-    "Manually loading the engine is deprecated and will be removed in v3.0.0. " \
-    "Remove `require \"view_component/engine\"`."
+  ViewComponent::Deprecation.deprecation_warning(
+    "Manually loading the engine",
+    "remove `require \"view_component/engine\"`"
   )
 elsif defined?(Rails::Engine)
   require "view_component/engine"

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.74.1
+  version: 2.82.0
 platform: ruby
 authors:
 - ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-10-10 00:00:00.000000000 Z
+date: 2023-01-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -16,7 +16,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 5.0.0
+        version: 5.2.0
     - - "<"
       - !ruby/object:Gem::Version
         version: '8.0'
@@ -322,6 +322,7 @@ files:
 - app/assets/vendor/prism.min.js
 - app/controllers/concerns/view_component/preview_actions.rb
 - app/controllers/view_components_controller.rb
+- app/controllers/view_components_system_test_controller.rb
 - app/helpers/preview_helper.rb
 - app/views/test_mailer/test_email.html.erb
 - app/views/view_components/_preview_source.html.erb
@@ -377,6 +378,8 @@ files:
 - lib/view_component/slot_v2.rb
 - lib/view_component/slotable.rb
 - lib/view_component/slotable_v2.rb
+- lib/view_component/system_test_case.rb
+- lib/view_component/system_test_helpers.rb
 - lib/view_component/template_error.rb
 - lib/view_component/test_case.rb
 - lib/view_component/test_helpers.rb