view_component 4.0.0.alpha6 → 4.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dbca6043a0eebf7c6f63358c7b1c193ef59170b81a35eb9290f211d365bfb3cb
-  data.tar.gz: 033db44d3dab35956b7ab8ac1a1a12673b7e82a0d4e0bbf3d3e791234dbcf757
+  metadata.gz: 7a112fdf735637f91b77151d96244fac83f0d78141df7a2a0ff8f2d72d0df2d0
+  data.tar.gz: 39c33408d7f256dc0da92edb17ca18460d776e6f1be89ba63d28e3ea102f8ba9
 SHA512:
-  metadata.gz: ddd3ac59908bf697da69f8f0fa29b2e779e468a07a6f37e96240165797fce088bbf6937473363d349b7e48fa8011434377b52345c8f60204ff94a7a794a4fee8
-  data.tar.gz: c8fac0e676aa9632453337a13169b690ed36bc9cd65e0de754c63f77878ba1b598c9a344f8f547a8b7c530c0e12c285de2fc0eee3afa4a1f7fe8805293414b8e
+  metadata.gz: b4c4f99335d6c2be623f1bd167e3d27567a7093acb388be1c245a6652423e4cc0ee8a16946da2d5ca9d35dd0283fecb1647888def129ec6fb75b82f427379558
+  data.tar.gz: 0ccb738fb45917ee49886ad2b1359a9bd3d98bf86d7e25f81422cffa5390514fe45d254a1e2d5900b6aa5649f428fa512d6a26c6d486d67546da8729dcc0d26f

data/app/controllers/concerns/view_component/preview_actions.rb

@@ -8,7 +8,7 @@ module ViewComponent
       prepend_view_path File.expand_path("../../../views", __dir__)
 
       around_action :set_locale, only: :previews
-      before_action :require_local!, unless: :show_previews?
+      before_action :require_local!, unless: :previews_enabled?
 
       content_security_policy(false)
 
@@ -51,8 +51,8 @@ module ViewComponent
     end
 
     # :doc:
-    def show_previews?
-      ViewComponent::Base.config.show_previews
+    def previews_enabled?
+      ViewComponent::Base.config.previews.enabled
     end
 
     # :doc:

data/app/views/test_mailer/test_url_email.html.erb

@@ -0,0 +1 @@
+<%= render(UrlForMailerComponent.new) %>

data/docs/CHANGELOG.md

@@ -10,6 +10,111 @@ nav_order: 6
 
 ## main
 
+## 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.
+
+    *Joel Hawksley*
+
+* BREAKING: Support compatibility with `Dry::Initializer`. As a result, `EmptyOrInvalidInitializerError` will no longer be raised.
+
+    *Joel Hawksley*
+
+* BREAKING: Rename `config.generate.component_parent_class` to `config.generate.parent_class`.
+
+    *Joel Hawksley*
+
+* Fix bug where `config.previews.enabled` didn't function properly in production environments.
+
+    *Joel Hawksley*
+
+* `config.previews.default_layout` should default to nil.
+
+    *Joel Hawksley*
+
+* Add test case for absolute URL path helpers in mailers.
+
+    *Joel Hawksley*
+
+* Fix bug where response format wasn't set, which caused issues with Turbo Frames.
+
+    *Joel Hawksley*
+
 ## 4.0.0.alpha6
 
 * BREAKING: Remove `config.test_controller` in favor of `vc_test_controller_class` test helper method.
@@ -129,11 +234,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*
@@ -142,11 +247,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*
 
@@ -186,6 +291,10 @@ This release makes the following breaking changes:
 
     *Simon Fish*
 
+* Deprecate `use_helper(s)`. Use `include MyHelper` or `helpers.` proxy instead.
+
+    *Joel Hawksley*
+
 * Reduce string allocations during compilation.
 
     *Jonathan del Strother*

data/lib/view_component/base.rb

@@ -14,7 +14,6 @@ require "view_component/slotable"
 require "view_component/template"
 require "view_component/translatable"
 require "view_component/with_content_helper"
-require "view_component/use_helpers"
 
 module ActionView
   class OutputBuffer
@@ -48,11 +47,11 @@ module ViewComponent
     end
 
     include ActionView::Helpers
+    include Rails.application.routes.url_helpers if defined?(Rails) && Rails.application
     include ERB::Escape
     include ActiveSupport::CoreExt::ERBUtil
 
     include ViewComponent::InlineTemplate
-    include ViewComponent::UseHelpers
     include ViewComponent::Slotable
     include ViewComponent::Translatable
     include ViewComponent::WithContentHelper
@@ -70,8 +69,9 @@ module ViewComponent
     delegate :content_security_policy_nonce, to: :helpers
 
     # Config option that strips trailing whitespace in templates before compiling them.
-    class_attribute :__vc_strip_trailing_whitespace, instance_accessor: false, instance_predicate: false
-    self.__vc_strip_trailing_whitespace = false # class_attribute:default doesn't work until Rails 5.2
+    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
@@ -91,6 +91,11 @@ module ViewComponent
 
     using RequestDetails
 
+    # Including `Rails.application.routes.url_helpers` defines an initializer that accepts (...),
+    # so we have to define our own empty initializer to overwrite it.
+    def initialize
+    end
+
     # Entrypoint for rendering components.
     #
     # - `view_context`: ActionView context from calling view
@@ -103,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
@@ -135,13 +141,15 @@ module ViewComponent
         value = nil
 
         @output_buffer.with_buffer do
+          @view_context.instance_variable_set(:@virtual_path, virtual_path)
+
           rendered_template = render_template_for(@__vc_requested_details).to_s
 
           # Avoid allocating new string when output_preamble and output_postamble are blank
           value = if output_preamble.blank? && output_postamble.blank?
             rendered_template
           else
-            safe_output_preamble + rendered_template + safe_output_postamble
+            __vc_safe_output_preamble + rendered_template + __vc_safe_output_postamble
           end
         end
 
@@ -155,6 +163,7 @@ module ViewComponent
         ""
       end
     ensure
+      view_context.instance_variable_set(:@virtual_path, old_virtual_path)
       @current_template = old_current_template
     end
 
@@ -334,6 +343,10 @@ module ViewComponent
       __vc_render_in_block_provided? || __vc_content_set_by_with_content_defined?
     end
 
+    def format
+      self.class.__vc_response_format
+    end
+
     private
 
     attr_reader :view_context
@@ -346,11 +359,7 @@ module ViewComponent
       defined?(@__vc_content_set_by_with_content)
     end
 
-    def content_evaluated?
-      defined?(@__vc_content_evaluated) && @__vc_content_evaluated
-    end
-
-    def maybe_escape_html(text)
+    def __vc_maybe_escape_html(text)
       return text if @current_template && !@current_template.html?
       return text if text.blank?
 
@@ -362,14 +371,14 @@ module ViewComponent
       end
     end
 
-    def safe_output_preamble
-      maybe_escape_html(output_preamble) do
+    def __vc_safe_output_preamble
+      __vc_maybe_escape_html(output_preamble) do
         Kernel.warn("WARNING: The #{self.class} component was provided an HTML-unsafe preamble. The preamble will be automatically escaped, but you may want to investigate.")
       end
     end
 
-    def safe_output_postamble
-      maybe_escape_html(output_postamble) do
+    def __vc_safe_output_postamble
+      __vc_maybe_escape_html(output_postamble) do
         Kernel.warn("WARNING: The #{self.class} component was provided an HTML-unsafe postamble. The postamble will be automatically escaped, but you may want to investigate.")
       end
     end
@@ -432,12 +441,12 @@ module ViewComponent
     #
     #  Defaults to `false`.
     #
-    # #### component_parent_class
+    # #### ßparent_class
     #
     # Parent class for generated components
     #
     # ```ruby
-    # config.view_component.generate.component_parent_class = "MyBaseComponent"
+    # config.view_component.generate.parent_class = "MyBaseComponent"
     # ```
     #
     # Defaults to nil. If this is falsy, generators will use
@@ -511,6 +520,11 @@ module ViewComponent
         Collection.new(self, collection, spacer_component, **args)
       end
 
+      # @private
+      def __vc_compile(raise_errors: false, force: false)
+        __vc_compiler.compile(raise_errors: raise_errors, force: force)
+      end
+
       # @private
       def inherited(child)
         # Compile so child will inherit compiled `call_*` template methods that
@@ -533,12 +547,6 @@ module ViewComponent
           RUBY
         end
 
-        # If Rails application is loaded, add application url_helpers to the component context
-        # we need to check this to use this gem as a dependency
-        if defined?(Rails) && Rails.application && !(child < Rails.application.routes.url_helpers)
-          child.include Rails.application.routes.url_helpers
-        end
-
         # Derive the source location of the component Ruby file from the call stack.
         # We need to ignore `inherited` frames here as they indicate that `inherited`
         # has been re-defined by the consuming application, likely in ApplicationComponent.
@@ -548,7 +556,7 @@ module ViewComponent
         child.virtual_path = child.name&.underscore
 
         # Set collection parameter to the extended component
-        child.with_collection_parameter provided_collection_parameter
+        child.with_collection_parameter(__vc_provided_collection_parameter)
 
         if instance_methods(false).include?(:render_template_for)
           vc_ancestor_calls = defined?(@__vc_ancestor_calls) ? @__vc_ancestor_calls.dup : []
@@ -570,11 +578,6 @@ module ViewComponent
         __vc_compile unless __vc_compiled?
       end
 
-      # @private
-      def __vc_compile(raise_errors: false, force: false)
-        __vc_compiler.compile(raise_errors: raise_errors, force: force)
-      end
-
       # @private
       def __vc_compiler
         @__vc_compiler ||= Compiler.new(self)
@@ -588,8 +591,8 @@ module ViewComponent
       #
       # @param parameter [Symbol] The parameter name used when rendering elements of a collection.
       def with_collection_parameter(parameter)
-        @provided_collection_parameter = parameter
-        @initialize_parameters = nil
+        @__vc_provided_collection_parameter = parameter
+        @__vc_initialize_parameters = nil
       end
 
       # Strips trailing whitespace from templates before compiling them.
@@ -619,17 +622,10 @@ module ViewComponent
       # rendering is optional.
       # @private
       def __vc_validate_collection_parameter!(validate_default: false)
-        parameter = validate_default ? __vc_collection_parameter : provided_collection_parameter
+        parameter = validate_default ? __vc_collection_parameter : __vc_provided_collection_parameter
 
         return unless parameter
-        return if initialize_parameter_names.include?(parameter) || splatted_keyword_argument_present?
-
-        # If Ruby can't parse the component class, then the initialize
-        # parameters will be empty and ViewComponent will not be able to render
-        # the component.
-        if initialize_parameters.empty?
-          raise EmptyOrInvalidInitializerError.new(name, parameter)
-        end
+        return if __vc_initialize_parameter_names.include?(parameter) || __vc_splatted_keyword_argument_present?
 
         raise MissingCollectionArgumentError.new(name, parameter)
       end
@@ -639,55 +635,57 @@ module ViewComponent
       # methods.
       # @private
       def __vc_validate_initialization_parameters!
-        return unless initialize_parameter_names.include?(:content)
+        return unless __vc_initialize_parameter_names.include?(:content)
 
         raise ReservedParameterError.new(name, :content)
       end
 
       # @private
       def __vc_collection_parameter
-        provided_collection_parameter || name && name.demodulize.underscore.chomp("_component").to_sym
+        @__vc_provided_collection_parameter ||= name && name.demodulize.underscore.chomp("_component").to_sym
       end
 
       # @private
       def __vc_collection_counter_parameter
-        :"#{__vc_collection_parameter}_counter"
+        @__vc_collection_counter_parameter ||= :"#{__vc_collection_parameter}_counter"
       end
 
       # @private
       def __vc_counter_argument_present?
-        initialize_parameter_names.include?(__vc_collection_counter_parameter)
+        __vc_initialize_parameter_names.include?(__vc_collection_counter_parameter)
       end
 
       # @private
       def __vc_collection_iteration_parameter
-        :"#{__vc_collection_parameter}_iteration"
+        @__vc_collection_iteration_parameter ||= :"#{__vc_collection_parameter}_iteration"
       end
 
       # @private
       def __vc_iteration_argument_present?
-        initialize_parameter_names.include?(__vc_collection_iteration_parameter)
+        __vc_initialize_parameter_names.include?(__vc_collection_iteration_parameter)
       end
 
       private
 
-      def splatted_keyword_argument_present?
-        initialize_parameters.flatten.include?(:keyrest) &&
-          !initialize_parameters.include?([:keyrest, :**]) # Un-named splatted keyword args don't count!
+      def __vc_splatted_keyword_argument_present?
+        __vc_initialize_parameters.flatten.include?(:keyrest)
       end
 
-      def initialize_parameter_names
-        return attribute_names.map(&:to_sym) if respond_to?(:attribute_names)
-
-        initialize_parameters.map(&:last)
+      def __vc_initialize_parameter_names
+        @__vc_initialize_parameter_names ||=
+          if respond_to?(:attribute_names)
+            attribute_names.map(&:to_sym)
+          else
+            __vc_initialize_parameters.map(&:last)
+          end
       end
 
-      def initialize_parameters
-        @initialize_parameters ||= instance_method(:initialize).parameters
+      def __vc_initialize_parameters
+        @__vc_initialize_parameters ||= instance_method(:initialize).parameters
       end
 
-      def provided_collection_parameter
-        @provided_collection_parameter ||= nil
+      def __vc_provided_collection_parameter
+        @__vc_provided_collection_parameter ||= nil
       end
     end
 

data/lib/view_component/compiler.rb

@@ -48,7 +48,16 @@ module ViewComponent
 
         define_render_template_for
 
-        @component.register_default_slots
+        # 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
 
         CompileCache.register(@component)
@@ -109,6 +118,7 @@ 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 }
@@ -167,10 +177,10 @@ module ViewComponent
 
     def gather_templates
       @templates ||=
-        if @component.inline_template.present?
+        if @component.__vc_inline_template.present?
           [Template::Inline.new(
             component: @component,
-            inline_template: @component.inline_template
+            inline_template: @component.__vc_inline_template
           )]
         else
           path_parser = ActionView::Resolver::PathParser.new

data/lib/view_component/config.rb

@@ -118,9 +118,9 @@ module ViewComponent
       #
       # #### `#default_layout`
       #
-      # A custom default layout used for the previews index page and individual previews. Defaults to `false`:
+      # A custom default layout used for the previews index page and individual previews. Defaults to `nil`:
       #
-      #     config.view_component.previews.default_layout = false
+      #     config.view_component.previews.default_layout = "preview_layout"
       #
 
       # @!attribute instrumentation_enabled
@@ -128,12 +128,6 @@ module ViewComponent
       # Whether ActiveSupport notifications are enabled.
       # Defaults to `false`.
 
-      # @!attribute test_controller
-      # @return [String]
-      # The controller used for testing components.
-      # Can also be configured on a per-test basis using `#with_controller_class`.
-      # Defaults to `ApplicationController`.
-
       def default_preview_paths
         (default_rails_preview_paths + default_rails_engines_preview_paths).uniq
       end
@@ -170,7 +164,7 @@ module ViewComponent
         options.controller = "ViewComponentsController"
         options.route = "/rails/view_components"
         options.enabled = Rails.env.development? || Rails.env.test?
-        options.default_layout = false
+        options.default_layout = nil
         options.paths = default_preview_paths
         options
       end

data/lib/view_component/configurable.rb

@@ -5,7 +5,7 @@ module ViewComponent
     extend ActiveSupport::Concern
 
     included do
-      next if respond_to?(:config) && config.respond_to?(:view_component) && config.respond_to_missing?(:test_controller)
+      next if respond_to?(:config) && config.respond_to?(:view_component) && config.respond_to_missing?(:instrumentation_enabled)
 
       include ActiveSupport::Configurable
 

data/lib/view_component/engine.rb

@@ -15,9 +15,9 @@ module ViewComponent
         options[config_option] ||= ViewComponent::Base.public_send(config_option)
       end
       options.instrumentation_enabled = false if options.instrumentation_enabled.nil?
-      options.show_previews = (Rails.env.development? || Rails.env.test?) if options.show_previews.nil?
+      options.previews.enabled = (Rails.env.development? || Rails.env.test?) if options.previews.enabled.nil?
 
-      if options.show_previews
+      if options.previews.enabled
         # This is still necessary because when `config.view_component` is declared, `Rails.root` is unspecified.
         options.previews.paths << "#{Rails.root}/test/components/previews" if defined?(Rails.root) && Dir.exist?(
           "#{Rails.root}/test/components/previews"
@@ -36,7 +36,7 @@ module ViewComponent
     initializer "view_component.set_autoload_paths" do |app|
       options = app.config.view_component
 
-      if options.show_previews && !options.previews.paths.empty?
+      if options.previews.enabled && !options.previews.paths.empty?
         paths_to_add = options.previews.paths - ActiveSupport::Dependencies.autoload_paths
         ActiveSupport::Dependencies.autoload_paths.concat(paths_to_add) if paths_to_add.any?
       end
@@ -88,7 +88,7 @@ module ViewComponent
     config.after_initialize do |app|
       options = app.config.view_component
 
-      if options.show_previews
+      if options.previews.enabled
         app.routes.prepend do
           preview_controller = options.previews.controller.sub(/Controller$/, "").underscore
 

data/lib/view_component/errors.rb

@@ -65,18 +65,6 @@ module ViewComponent
     end
   end
 
-  class EmptyOrInvalidInitializerError < StandardError
-    MESSAGE =
-      "The COMPONENT initializer is empty or invalid. " \
-      "It must accept the parameter `PARAMETER` to render it as a collection.\n\n" \
-      "To fix this issue, update the initializer to accept `PARAMETER`.\n\n" \
-      "See [the collections docs](https://viewcomponent.org/guide/collections.html) for more information on rendering collections."
-
-    def initialize(klass_name, parameter)
-      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("PARAMETER", parameter.to_s))
-    end
-  end
-
   class MissingCollectionArgumentError < StandardError
     MESSAGE =
       "The initializer for COMPONENT doesn't accept the parameter `PARAMETER`, " \

data/lib/view_component/inline_template.rb

@@ -37,7 +37,7 @@ module ViewComponent # :nodoc:
         method.end_with?("_template") || super
       end
 
-      def inline_template
+      def __vc_inline_template
         @__vc_inline_template if defined?(@__vc_inline_template)
       end
 

data/lib/view_component/slotable.rb

@@ -73,25 +73,25 @@ module ViewComponent
       #
       #   <%= render_inline(MyComponent.new.with_header_content("Foo")) %>
       def renders_one(slot_name, callable = nil)
-        validate_singular_slot_name(slot_name)
+        __vc_validate_singular_slot_name(slot_name)
 
         if callable.is_a?(Hash) && callable.key?(:types)
-          register_polymorphic_slot(slot_name, callable[:types], collection: false)
+          __vc_register_polymorphic_slot(slot_name, callable[:types], collection: false)
         else
-          validate_plural_slot_name(ActiveSupport::Inflector.pluralize(slot_name).to_sym)
+          __vc_validate_plural_slot_name(ActiveSupport::Inflector.pluralize(slot_name).to_sym)
 
           setter_method_name = :"with_#{slot_name}"
 
           define_method setter_method_name do |*args, **kwargs, &block|
-            set_slot(slot_name, nil, *args, **kwargs, &block)
+            __vc_set_slot(slot_name, nil, *args, **kwargs, &block)
           end
 
           self::GeneratedSlotMethods.define_method slot_name do
-            get_slot(slot_name)
+            __vc_get_slot(slot_name)
           end
 
           self::GeneratedSlotMethods.define_method :"#{slot_name}?" do
-            get_slot(slot_name).present?
+            __vc_get_slot(slot_name).present?
           end
 
           define_method :"with_#{slot_name}_content" do |content|
@@ -100,7 +100,7 @@ module ViewComponent
             self
           end
 
-          register_slot(slot_name, collection: false, callable: callable)
+          __vc_register_slot(slot_name, collection: false, callable: callable)
         end
       end
 
@@ -142,18 +142,18 @@ module ViewComponent
       #     <% end %>
       #   <% end %>
       def renders_many(slot_name, callable = nil)
-        validate_plural_slot_name(slot_name)
+        __vc_validate_plural_slot_name(slot_name)
 
         if callable.is_a?(Hash) && callable.key?(:types)
-          register_polymorphic_slot(slot_name, callable[:types], collection: true)
+          __vc_register_polymorphic_slot(slot_name, callable[:types], collection: true)
         else
           singular_name = ActiveSupport::Inflector.singularize(slot_name)
-          validate_singular_slot_name(ActiveSupport::Inflector.singularize(slot_name).to_sym)
+          __vc_validate_singular_slot_name(ActiveSupport::Inflector.singularize(slot_name).to_sym)
 
           setter_method_name = :"with_#{singular_name}"
 
           define_method setter_method_name do |*args, **kwargs, &block|
-            set_slot(slot_name, nil, *args, **kwargs, &block)
+            __vc_set_slot(slot_name, nil, *args, **kwargs, &block)
           end
 
           define_method :"with_#{singular_name}_content" do |content|
@@ -165,22 +165,22 @@ module ViewComponent
           define_method :"with_#{slot_name}" do |collection_args = nil, &block|
             collection_args.map do |args|
               if args.respond_to?(:to_hash)
-                set_slot(slot_name, nil, **args, &block)
+                __vc_set_slot(slot_name, nil, **args, &block)
               else
-                set_slot(slot_name, nil, *args, &block)
+                __vc_set_slot(slot_name, nil, *args, &block)
               end
             end
           end
 
           self::GeneratedSlotMethods.define_method slot_name do
-            get_slot(slot_name)
+            __vc_get_slot(slot_name)
           end
 
           self::GeneratedSlotMethods.define_method :"#{slot_name}?" do
-            get_slot(slot_name).present?
+            __vc_get_slot(slot_name).present?
           end
 
-          register_slot(slot_name, collection: true, callable: callable)
+          __vc_register_slot(slot_name, collection: true, callable: callable)
         end
       end
 
@@ -211,8 +211,9 @@ module ViewComponent
         super
       end
 
+      # @private
       # Called by the compiler, as instance methods are not defined when slots are first registered
-      def register_default_slots
+      def __vc_register_default_slots
         registered_slots.each do |slot_name, config|
           default_method_name = :"default_#{slot_name}"
           config[:default_method] = instance_methods.find { |method_name| method_name == default_method_name }
@@ -223,17 +224,17 @@ module ViewComponent
 
       private
 
-      def register_slot(slot_name, **kwargs)
-        registered_slots[slot_name] = define_slot(slot_name, **kwargs)
+      def __vc_register_slot(slot_name, **kwargs)
+        registered_slots[slot_name] = __vc_define_slot(slot_name, **kwargs)
       end
 
-      def register_polymorphic_slot(slot_name, types, collection:)
+      def __vc_register_polymorphic_slot(slot_name, types, collection:)
         self::GeneratedSlotMethods.define_method(slot_name) do
-          get_slot(slot_name)
+          __vc_get_slot(slot_name)
         end
 
         self::GeneratedSlotMethods.define_method(:"#{slot_name}?") do
-          get_slot(slot_name).present?
+          __vc_get_slot(slot_name).present?
         end
 
         renderable_hash = types.each_with_object({}) do |(poly_type, poly_attributes_or_callable), memo|
@@ -252,7 +253,7 @@ module ViewComponent
               "#{slot_name}_#{poly_type}"
             end
 
-          memo[poly_type] = define_slot(
+          memo[poly_type] = __vc_define_slot(
             poly_slot_name, collection: collection, callable: poly_callable
           )
 
@@ -263,7 +264,7 @@ module ViewComponent
           end
 
           define_method(setter_method_name) do |*args, **kwargs, &block|
-            set_polymorphic_slot(slot_name, poly_type, *args, **kwargs, &block)
+            __vc_set_polymorphic_slot(slot_name, poly_type, *args, **kwargs, &block)
           end
 
           define_method :"with_#{poly_slot_name}_content" do |content|
@@ -279,7 +280,7 @@ module ViewComponent
         }
       end
 
-      def define_slot(slot_name, collection:, callable:)
+      def __vc_define_slot(slot_name, collection:, callable:)
         slot = {collection: collection}
         return slot unless callable
 
@@ -302,18 +303,18 @@ module ViewComponent
         slot
       end
 
-      def validate_plural_slot_name(slot_name)
+      def __vc_validate_plural_slot_name(slot_name)
         if RESERVED_NAMES[:plural].include?(slot_name.to_sym)
           raise ReservedPluralSlotNameError.new(name, slot_name)
         end
 
-        raise_if_slot_name_uncountable(slot_name)
-        raise_if_slot_conflicts_with_call(slot_name)
-        raise_if_slot_ends_with_question_mark(slot_name)
-        raise_if_slot_registered(slot_name)
+        __vc_raise_if_slot_name_uncountable(slot_name)
+        __vc_raise_if_slot_conflicts_with_call(slot_name)
+        __vc_raise_if_slot_ends_with_question_mark(slot_name)
+        __vc_raise_if_slot_registered(slot_name)
       end
 
-      def validate_singular_slot_name(slot_name)
+      def __vc_validate_singular_slot_name(slot_name)
         if slot_name.to_sym == :content
           raise ContentSlotNameError.new(name)
         end
@@ -322,28 +323,28 @@ module ViewComponent
           raise ReservedSingularSlotNameError.new(name, slot_name)
         end
 
-        raise_if_slot_conflicts_with_call(slot_name)
-        raise_if_slot_ends_with_question_mark(slot_name)
-        raise_if_slot_registered(slot_name)
+        __vc_raise_if_slot_conflicts_with_call(slot_name)
+        __vc_raise_if_slot_ends_with_question_mark(slot_name)
+        __vc_raise_if_slot_registered(slot_name)
       end
 
-      def raise_if_slot_registered(slot_name)
+      def __vc_raise_if_slot_registered(slot_name)
         if registered_slots.key?(slot_name)
           raise RedefinedSlotError.new(name, slot_name)
         end
       end
 
-      def raise_if_slot_ends_with_question_mark(slot_name)
+      def __vc_raise_if_slot_ends_with_question_mark(slot_name)
         raise SlotPredicateNameError.new(name, slot_name) if slot_name.to_s.end_with?("?")
       end
 
-      def raise_if_slot_conflicts_with_call(slot_name)
+      def __vc_raise_if_slot_conflicts_with_call(slot_name)
         if slot_name.start_with?("call_")
           raise InvalidSlotNameError, "Slot cannot start with 'call_'. Please rename #{slot_name}"
         end
       end
 
-      def raise_if_slot_name_uncountable(slot_name)
+      def __vc_raise_if_slot_name_uncountable(slot_name)
         slot_name = slot_name.to_s
         if slot_name.pluralize == slot_name.singularize
           raise UncountableSlotNameError.new(name, slot_name)
@@ -351,9 +352,9 @@ module ViewComponent
       end
     end
 
-    def get_slot(slot_name)
+    def __vc_get_slot(slot_name)
       @__vc_set_slots ||= {}
-      content unless content_evaluated? # ensure content is loaded so slots will be defined
+      content unless defined?(@__vc_content_evaluated) && @__vc_content_evaluated # ensure content is loaded so slots will be defined
 
       # If the slot is set, return it
       return @__vc_set_slots[slot_name] if @__vc_set_slots[slot_name]
@@ -376,7 +377,7 @@ module ViewComponent
       end
     end
 
-    def set_slot(slot_name, slot_definition = nil, *args, **kwargs, &block)
+    def __vc_set_slot(slot_name, slot_definition = nil, *args, **kwargs, &block)
       slot_definition ||= self.class.registered_slots[slot_name]
       slot = Slot.new(self)
 
@@ -433,7 +434,7 @@ module ViewComponent
       slot
     end
 
-    def set_polymorphic_slot(slot_name, poly_type = nil, *args, **kwargs, &block)
+    def __vc_set_polymorphic_slot(slot_name, poly_type = nil, *args, **kwargs, &block)
       slot_definition = self.class.registered_slots[slot_name]
 
       if !slot_definition[:collection] && defined?(@__vc_set_slots) && @__vc_set_slots[slot_name]
@@ -442,7 +443,7 @@ module ViewComponent
 
       poly_def = slot_definition[:renderable_hash][poly_type]
 
-      set_slot(slot_name, poly_def, *args, **kwargs, &block)
+      __vc_set_slot(slot_name, poly_def, *args, **kwargs, &block)
     end
   end
 end

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

@@ -43,7 +43,7 @@ module ViewComponent
       attr_reader :source
 
       def initialize(component:, inline_template:)
-        details = ActionView::TemplateDetails.new(nil, inline_template.language.to_sym, nil, nil)
+        details = ActionView::TemplateDetails.new(nil, inline_template.language.to_sym, DEFAULT_FORMAT, 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, nil, variant)
+        details = ActionView::TemplateDetails.new(nil, nil, DEFAULT_FORMAT, variant)
 
         super(component: component, details: details)
 
@@ -82,7 +82,7 @@ module ViewComponent
       def safe_method_name_call
         m = safe_method_name
         proc do
-          maybe_escape_html(send(m)) do
+          __vc_maybe_escape_html(send(m)) do
             Kernel.warn("WARNING: The #{self.class} component rendered HTML-unsafe output. " \
                           "The output will be automatically escaped, but you may want to investigate.")
           end
@@ -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/translatable.rb

@@ -70,12 +70,12 @@ module ViewComponent
 
       def initialize(scope:, load_paths:)
         @__vc_i18n_scope = scope.split(".").map(&:to_sym)
-        @load_paths = load_paths
+        @__vc_load_paths = load_paths
       end
 
       # Ensure the Simple backend won't load paths from ::I18n.load_path
       def load_translations
-        super(@load_paths)
+        super(@__vc_load_paths)
       end
 
       def scope_data(data)
@@ -100,7 +100,7 @@ module ViewComponent
       key = self.class.__vc_i18n_key(key, options.delete(:scope))
       as_html = HTML_SAFE_TRANSLATION_KEY.match?(key)
 
-      html_escape_translation_options!(options) if as_html
+      __vc_html_escape_translation_options!(options) if as_html
 
       if key.start_with?(__vc_i18n_scope + ".")
         translated =
@@ -113,7 +113,7 @@ module ViewComponent
           return @view_context.translate(key, locale: locale, **options)
         end
 
-        translated = html_safe_translation(translated) if as_html
+        translated = __vc_html_safe_translation(translated) if as_html
         translated
       else
         @view_context.translate(key, locale: locale, **options)
@@ -127,9 +127,9 @@ module ViewComponent
 
     private
 
-    def html_safe_translation(translation)
+    def __vc_html_safe_translation(translation)
       if translation.respond_to?(:map)
-        translation.map { |element| html_safe_translation(element) }
+        translation.map { |element| __vc_html_safe_translation(element) }
       else
         # It's assumed here that objects loaded by the i18n backend will respond to `#html_safe?`.
         # It's reasonable that if we're in Rails, `active_support/core_ext/string/output_safety.rb`
@@ -138,7 +138,7 @@ module ViewComponent
       end
     end
 
-    def html_escape_translation_options!(options)
+    def __vc_html_escape_translation_options!(options)
       options.except(*::I18n::RESERVED_KEYS).each do |name, value|
         next if name == :count && value.is_a?(Numeric)
 

data/lib/view_component/version.rb

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

data/lib/view_component.rb

@@ -7,7 +7,6 @@ module ViewComponent
   extend ActiveSupport::Autoload
 
   autoload :Base
-  autoload :CaptureCompatibility
   autoload :Compiler
   autoload :CompileCache
   autoload :Config
@@ -15,11 +14,15 @@ module ViewComponent
   autoload :InlineTemplate
   autoload :Instrumentation
   autoload :Preview
-  autoload :TestHelpers
-  autoload :SystemTestHelpers
-  autoload :TestCase
-  autoload :SystemTestCase
   autoload :Translatable
+
+  if Rails.env.test?
+    autoload :TestHelpers
+    autoload :SystemSpecHelpers
+    autoload :SystemTestHelpers
+    autoload :TestCase
+    autoload :SystemTestCase
+  end
 end
 
 require "view_component/engine" if defined?(Rails::Engine)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 4.0.0.alpha6
+  version: 4.0.0.rc1
 platform: ruby
 authors:
 - ViewComponent Team
@@ -54,6 +54,7 @@ files:
 - app/controllers/view_components_system_test_controller.rb
 - app/views/test_mailer/test_asset_email.html.erb
 - app/views/test_mailer/test_email.html.erb
+- app/views/test_mailer/test_url_email.html.erb
 - app/views/view_components/index.html.erb
 - app/views/view_components/preview.html.erb
 - app/views/view_components/previews.html.erb
@@ -74,13 +75,13 @@ 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
 - lib/view_component/test_case.rb
 - lib/view_component/test_helpers.rb
 - lib/view_component/translatable.rb
-- lib/view_component/use_helpers.rb
 - lib/view_component/version.rb
 - lib/view_component/with_content_helper.rb
 homepage: https://viewcomponent.org
@@ -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: []

data/lib/view_component/use_helpers.rb

@@ -1,41 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent::UseHelpers
-  extend ActiveSupport::Concern
-
-  class_methods do
-    def use_helpers(*args, from: nil, prefix: false)
-      args.each { |helper_method| use_helper(helper_method, from: from, prefix: prefix) }
-    end
-
-    def use_helper(helper_method, from: nil, prefix: false)
-      helper_method_name = full_helper_method_name(helper_method, prefix: prefix, source: from)
-
-      class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
-        def #{helper_method_name}(...)
-          raise HelpersCalledBeforeRenderError if view_context.nil?
-
-          #{define_helper(helper_method: helper_method, source: from)}
-        end
-      RUBY
-    end
-
-    private
-
-    def full_helper_method_name(helper_method, prefix: false, source: nil)
-      return helper_method unless prefix.present?
-
-      if !!prefix == prefix
-        "#{source.to_s.underscore}_#{helper_method}"
-      else
-        "#{prefix}_#{helper_method}"
-      end
-    end
-
-    def define_helper(helper_method:, source:)
-      return "__vc_original_view_context.#{helper_method}(...)" unless source.present?
-
-      "#{source}.instance_method(:#{helper_method}).bind(self).call(...)"
-    end
-  end
-end