view_component 3.23.2 → 4.0.1

data/lib/view_component/compiler.rb

@@ -8,7 +8,7 @@ module ViewComponent
     # * true (a blocking mode which ensures thread safety when redefining the `call` method for components,
     #                default in Rails development and test mode)
     # * false(a non-blocking mode, default in Rails production mode)
-    class_attribute :development_mode, default: false
+    class_attribute :__vc_development_mode, default: false
 
     def initialize(component)
       @component = component
@@ -30,8 +30,8 @@ module ViewComponent
 
         gather_templates
 
-        if self.class.development_mode && @templates.any?(&:requires_compiled_superclass?)
-          @component.superclass.compile(raise_errors: raise_errors)
+        if self.class.__vc_development_mode && @templates.any?(&:requires_compiled_superclass?)
+          @component.superclass.__vc_compile(raise_errors: raise_errors)
         end
 
         if template_errors.present?
@@ -42,19 +42,36 @@ module ViewComponent
         end
 
         if raise_errors
-          @component.validate_initialization_parameters!
-          @component.validate_collection_parameter!
+          @component.__vc_validate_initialization_parameters!
+          @component.__vc_validate_collection_parameter!
         end
 
         define_render_template_for
 
-        @component.register_default_slots
-        @component.build_i18n_backend
+        @component.__vc_register_default_slots
+        @component.__vc_build_i18n_backend
 
         CompileCache.register(@component)
       end
     end
 
+    # @return all matching compiled templates, in priority order based on the requested details from LookupContext
+    #
+    # @param [ActionView::TemplateDetails::Requested] requested_details i.e. locales, formats, variants
+    def find_templates_for(requested_details)
+      filtered_templates = @templates.select do |template|
+        template.details.matches?(requested_details)
+      end
+
+      if filtered_templates.count > 1
+        filtered_templates.sort_by! do |template|
+          template.details.sort_key_for(requested_details)
+        end
+      end
+
+      filtered_templates
+    end
+
     private
 
     attr_reader :templates
@@ -64,40 +81,25 @@ module ViewComponent
         template.compile_to_component
       end
 
-      method_body =
-        if @templates.one?
-          @templates.first.safe_method_name_call
-        elsif (template = @templates.find(&:inline?))
-          template.safe_method_name_call
-        else
-          branches = []
-
-          @templates.each do |template|
-            conditional =
-              if template.inline_call?
-                "variant&.to_sym == #{template.variant.inspect}"
-              else
-                [
-                  template.default_format? ? "(format == #{ViewComponent::Base::VC_INTERNAL_DEFAULT_FORMAT.inspect} || format.nil?)" : "format == #{template.format.inspect}",
-                  template.variant.nil? ? "variant.nil?" : "variant&.to_sym == #{template.variant.inspect}"
-                ].join(" && ")
-              end
-
-            branches << [conditional, template.safe_method_name_call]
-          end
+      @component.silence_redefinition_of_method(:render_template_for)
 
-          out = branches.each_with_object(+"") do |(conditional, branch_body), memo|
-            memo << "#{(!memo.present?) ? "if" : "elsif"} #{conditional}\n  #{branch_body}\n"
+      if @templates.one?
+        template = @templates.first
+        safe_call = template.safe_method_name_call
+        @component.define_method(:render_template_for) do |_|
+          @current_template = template
+          instance_exec(&safe_call)
+        end
+      else
+        compiler = self
+        @component.define_method(:render_template_for) do |details|
+          if (@current_template = compiler.find_templates_for(details).first)
+            instance_exec(&@current_template.safe_method_name_call)
+          else
+            raise MissingTemplateError.new(self.class.name, details)
           end
-          out << "else\n  #{templates.find { _1.variant.nil? && _1.default_format? }.safe_method_name_call}\nend"
         end
-
-      @component.silence_redefinition_of_method(:render_template_for)
-      @component.class_eval <<-RUBY, __FILE__, __LINE__ + 1
-      def render_template_for(variant = nil, format = nil)
-        #{method_body}
       end
-      RUBY
     end
 
     def template_errors
@@ -106,10 +108,7 @@ module ViewComponent
 
         errors << "Couldn't find a template file or inline render method for #{@component}." if @templates.empty?
 
-        # We currently allow components to have both an inline call method and a template for a variant, with the
-        # inline call method overriding the template. We should aim to change this in v4 to instead
-        # raise an error.
-        @templates.reject(&:inline_call?)
+        @templates
           .map { |template| [template.variant, template.format] }
           .tally
           .select { |_, count| count > 1 }
@@ -168,30 +167,18 @@ module ViewComponent
 
     def gather_templates
       @templates ||=
-        begin
+        if @component.__vc_inline_template.present?
+          [Template::Inline.new(
+            component: @component,
+            inline_template: @component.__vc_inline_template
+          )]
+        else
+          path_parser = ActionView::Resolver::PathParser.new
           templates = @component.sidecar_files(
             ActionView::Template.template_handler_extensions
           ).map do |path|
-            # Extract format and variant from template filename
-            this_format, variant =
-              File
-                .basename(path)     # "variants_component.html+mini.watch.erb"
-                .split(".")[1..-2]  # ["html+mini", "watch"]
-                .join(".")          # "html+mini.watch"
-                .split("+")         # ["html", "mini.watch"]
-                .map(&:to_sym)      # [:html, :"mini.watch"]
-
-            out = Template.new(
-              component: @component,
-              type: :file,
-              path: path,
-              lineno: 0,
-              extension: path.split(".").last,
-              this_format: this_format.to_s.split(".").last&.to_sym, # strip locale from this_format, see #2113
-              variant: variant
-            )
-
-            out
+            details = path_parser.parse(path).details
+            Template::File.new(component: @component, path: path, details: details)
           end
 
           component_instance_methods_on_self = @component.instance_methods(false)
@@ -201,24 +188,10 @@ module ViewComponent
           ).flat_map { |ancestor| ancestor.instance_methods(false).grep(/^call(_|$)/) }
             .uniq
             .each do |method_name|
-              templates << Template.new(
-                component: @component,
-                type: :inline_call,
-                this_format: ViewComponent::Base::VC_INTERNAL_DEFAULT_FORMAT,
-                variant: method_name.to_s.include?("call_") ? method_name.to_s.sub("call_", "").to_sym : nil,
-                method_name: method_name,
-                defined_on_self: component_instance_methods_on_self.include?(method_name)
-              )
-            end
-
-          if @component.inline_template.present?
-            templates << Template.new(
+            templates << Template::InlineCall.new(
               component: @component,
-              type: :inline,
-              path: @component.inline_template.path,
-              lineno: @component.inline_template.lineno,
-              source: @component.inline_template.source.dup,
-              extension: @component.inline_template.language
+              method_name: method_name,
+              defined_on_self: component_instance_methods_on_self.include?(method_name)
             )
           end
 

data/lib/view_component/config.rb

@@ -13,19 +13,8 @@ module ViewComponent
       def defaults
         ActiveSupport::OrderedOptions.new.merge!({
           generate: default_generate_options,
-          preview_controller: "ViewComponentsController",
-          preview_route: "/rails/view_components",
-          show_previews_source: false,
-          instrumentation_enabled: false,
-          use_deprecated_instrumentation_name: true,
-          render_monkey_patch_enabled: true,
-          view_component_path: "app/components",
-          component_parent_class: nil,
-          show_previews: Rails.env.development? || Rails.env.test?,
-          preview_paths: default_preview_paths,
-          test_controller: "ApplicationController",
-          default_preview_layout: nil,
-          capture_compatibility_patch_enabled: false
+          previews: default_previews_options,
+          instrumentation_enabled: false
         })
       end
 
@@ -36,6 +25,12 @@ module ViewComponent
       # All options under this namespace default to `false` unless otherwise
       # stated.
       #
+      # #### `#path`
+      #
+      # Where to put generated components. Defaults to `app/components`:
+      #
+      #     config.view_component.generate.path = "lib/components"
+      #
       # #### `#sidecar`
       #
       # Always generate a component with a sidecar directory:
@@ -83,96 +78,56 @@ module ViewComponent
       #
       # 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,
+      # `ViewComponent.config.previews.paths` if defined,
       # `"test/components/previews"` otherwise
       #
       # #### `#use_component_path_for_rspec_tests`
       #
-      # Whether to use the `config.view_component_path` when generating new
+      # Whether to use `config.generate.path` when generating new
       # RSpec component tests:
       #
       #     config.view_component.generate.use_component_path_for_rspec_tests = true
       #
-      # When set to `true`, the generator will use the `view_component_path` to
+      # When set to `true`, the generator will use the `path` to
       # decide where to generate the new RSpec component test.
-      # For example, if the `view_component_path` is
+      # For example, if the `path` is
       # `app/views/components`, then the generator will create a new spec file
       # in `spec/views/components/` rather than the default `spec/components/`.
 
-      # @!attribute preview_controller
-      # @return [String]
-      # The controller used for previewing components.
-      # Defaults to `ViewComponentsController`.
-
-      # @!attribute preview_route
-      # @return [String]
-      # The entry route for component previews.
-      # Defaults to `"/rails/view_components"`.
-
-      # @!attribute show_previews_source
-      # @return [Boolean]
-      # Whether to display source code previews in component previews.
-      # Defaults to `false`.
+      # @!attribute previews
+      # @return [ActiveSupport::OrderedOptions]
+      # The subset of configuration options relating to previews.
+      #
+      # #### `#controller`
+      #
+      # The controller used for previewing components. Defaults to `ViewComponentsController`:
+      #
+      #     config.view_component.previews.controller = "MyPreviewController"
+      #
+      # #### `#route`
+      #
+      # The entry route for component previews. Defaults to `/rails/view_components`:
+      #
+      #     config.view_component.previews.route = "/my_previews"
+      #
+      # #### `#enabled`
+      #
+      # Whether component previews are enabled. Defaults to `true` in development and test environments:
+      #
+      #     config.view_component.previews.enabled = false
+      #
+      # #### `#default_layout`
+      #
+      # A custom default layout used for the previews index page and individual previews. Defaults to `nil`:
+      #
+      #     config.view_component.previews.default_layout = "preview_layout"
+      #
 
       # @!attribute instrumentation_enabled
       # @return [Boolean]
       # Whether ActiveSupport notifications are enabled.
       # Defaults to `false`.
 
-      # @!attribute use_deprecated_instrumentation_name
-      # @return [Boolean]
-      # Whether ActiveSupport Notifications use the private name `"!render.view_component"`
-      # or are made more publicly available via `"render.view_component"`.
-      # Will be removed in next major version.
-      # Defaults to `true`.
-
-      # @!attribute render_monkey_patch_enabled
-      # @return [Boolean] Whether the #render method should be monkey patched.
-      # If this is disabled, use `#render_component` or
-      # `#render_component_to_string` instead.
-      # Defaults to `true`.
-
-      # @!attribute view_component_path
-      # @return [String]
-      # The path in which components, their templates, and their sidecars should
-      # be stored.
-      # Defaults to `"app/components"`.
-
-      # @!attribute component_parent_class
-      # @return [String]
-      # The parent class from which generated components will inherit.
-      # Defaults to `nil`. If this is falsy, generators will use
-      # `"ApplicationComponent"` if defined, `"ViewComponent::Base"` otherwise.
-
-      # @!attribute show_previews
-      # @return [Boolean]
-      # Whether component previews are enabled.
-      # Defaults to `true` in development and test environments.
-
-      # @!attribute preview_paths
-      # @return [Array<String>]
-      # The locations in which component previews will be looked up.
-      # Defaults to `['test/components/previews']` relative to your Rails root.
-
-      # @!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`.
-
-      # @!attribute default_preview_layout
-      # @return [String]
-      # A custom default layout used for the previews index page and individual
-      # previews.
-      # Defaults to `nil`. If this is falsy, `"component_preview"` is used.
-
-      # @!attribute capture_compatibility_patch_enabled
-      # @return [Boolean]
-      # Enables the experimental capture compatibility patch that makes ViewComponent
-      # compatible with forms, capture, and other built-ins.
-      # previews.
-      # Defaults to `false`.
-
       def default_preview_paths
         (default_rails_preview_paths + default_rails_engines_preview_paths).uniq
       end
@@ -200,6 +155,17 @@ module ViewComponent
       def default_generate_options
         options = ActiveSupport::OrderedOptions.new(false)
         options.preview_path = ""
+        options.path = "app/components"
+        options
+      end
+
+      def default_previews_options
+        options = ActiveSupport::OrderedOptions.new
+        options.controller = "ViewComponentsController"
+        options.route = "/rails/view_components"
+        options.enabled = Rails.env.development? || Rails.env.test?
+        options.default_layout = nil
+        options.paths = default_preview_paths
         options
       end
     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/deprecation.rb

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

data/lib/view_component/engine.rb

@@ -8,159 +8,99 @@ module ViewComponent
   class Engine < Rails::Engine # :nodoc:
     config.view_component = ViewComponent::Config.current
 
-    if Rails.version.to_f < 8.0
-      rake_tasks do
-        load "view_component/rails/tasks/view_component.rake"
-      end
-    else
-      initializer "view_component.stats_directories" do |app|
-        require "rails/code_statistics"
-
-        if Rails.root.join(ViewComponent::Base.view_component_path).directory?
-          Rails::CodeStatistics.register_directory("ViewComponents", ViewComponent::Base.view_component_path)
-        end
-
-        if Rails.root.join("test/components").directory?
-          Rails::CodeStatistics.register_directory("ViewComponent tests", "test/components", test_directory: true)
-        end
-      end
-    end
-
     initializer "view_component.set_configs" do |app|
       options = app.config.view_component
 
-      %i[generate preview_controller preview_route show_previews_source].each do |config_option|
+      %i[generate previews].each do |config_option|
         options[config_option] ||= ViewComponent::Base.public_send(config_option)
       end
       options.instrumentation_enabled = false if options.instrumentation_enabled.nil?
-      options.render_monkey_patch_enabled = true if options.render_monkey_patch_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.preview_paths << "#{Rails.root}/test/components/previews" if defined?(Rails.root) && Dir.exist?(
+        options.previews.paths << "#{Rails.root}/test/components/previews" if defined?(Rails.root) && Dir.exist?(
           "#{Rails.root}/test/components/previews"
         )
-
-        if options.show_previews_source
-          require "method_source"
-
-          app.config.to_prepare do
-            MethodSource.instance_variable_set(:@lines_for_file, {})
-          end
-        end
       end
     end
 
     initializer "view_component.enable_instrumentation" do |app|
       ActiveSupport.on_load(:view_component) do
         if app.config.view_component.instrumentation_enabled.present?
-          # :nocov: Re-executing the below in tests duplicates initializers and causes order-dependent failures.
           ViewComponent::Base.prepend(ViewComponent::Instrumentation)
-          if app.config.view_component.use_deprecated_instrumentation_name
-            ViewComponent::Deprecation.deprecation_warning(
-              "!render.view_component",
-              "Use the new instrumentation key `render.view_component` instead. See https://viewcomponent.org/guide/instrumentation.html"
-            )
-          end
-          # :nocov:
         end
       end
     end
 
-    # :nocov:
-    initializer "view_component.enable_capture_patch" do |app|
-      ActiveSupport.on_load(:view_component) do
-        ActionView::Base.include(ViewComponent::CaptureCompatibility) if app.config.view_component.capture_compatibility_patch_enabled
-      end
-    end
-    # :nocov:
-
     initializer "view_component.set_autoload_paths" do |app|
       options = app.config.view_component
 
-      if options.show_previews && !options.preview_paths.empty?
-        paths_to_add = options.preview_paths - ActiveSupport::Dependencies.autoload_paths
+      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
     end
 
-    initializer "view_component.eager_load_actions" do
-      ActiveSupport.on_load(:after_initialize) do
-        ViewComponent::Base.descendants.each(&:compile) if Rails.application.config.eager_load
+    initializer "view_component.propshaft_support" do |_app|
+      ActiveSupport.on_load(:view_component) do
+        if defined?(Propshaft)
+          include Propshaft::Helper
+        end
       end
     end
 
-    initializer "view_component.monkey_patch_render" do |app|
-      next if Rails.version.to_f >= 6.1 || !app.config.view_component.render_monkey_patch_enabled
-
-      # :nocov:
-      ViewComponent::Deprecation.deprecation_warning("Monkey patching `render`", "ViewComponent 4.0 will remove the `render` monkey patch")
-
-      ActiveSupport.on_load(:action_view) do
-        require "view_component/render_monkey_patch"
-        ActionView::Base.prepend ViewComponent::RenderMonkeyPatch
-      end
-
-      ActiveSupport.on_load(:action_controller) do
-        require "view_component/rendering_monkey_patch"
-        require "view_component/render_to_string_monkey_patch"
-        ActionController::Base.prepend ViewComponent::RenderingMonkeyPatch
-        ActionController::Base.prepend ViewComponent::RenderToStringMonkeyPatch
-      end
-      # :nocov:
-    end
+    config.after_initialize do |app|
+      ActiveSupport.on_load(:view_component) do
+        if defined?(Sprockets::Rails)
+          include Sprockets::Rails::Helper
 
-    initializer "view_component.include_render_component" do |_app|
-      next if Rails.version.to_f >= 6.1
+          # Copy relevant config to VC context
+          # See: https://github.com/rails/sprockets-rails/blob/266ec49f3c7c96018dd75f9dc4f9b62fe3f7eecf/lib/sprockets/railtie.rb#L245
+          self.debug_assets = app.config.assets.debug
+          self.digest_assets = app.config.assets.digest
+          self.assets_prefix = app.config.assets.prefix
+          self.assets_precompile = app.config.assets.precompile
 
-      # :nocov:
-      ViewComponent::Deprecation.deprecation_warning("using `render_component`", "ViewComponent 4.0 will remove `render_component`")
+          self.assets_environment = app.assets
+          self.assets_manifest = app.assets_manifest
 
-      ActiveSupport.on_load(:action_view) do
-        require "view_component/render_component_helper"
-        ActionView::Base.include ViewComponent::RenderComponentHelper
-      end
+          self.resolve_assets_with = app.config.assets.resolve_with
 
-      ActiveSupport.on_load(:action_controller) do
-        require "view_component/rendering_component_helper"
-        require "view_component/render_component_to_string_helper"
-        ActionController::Base.include ViewComponent::RenderingComponentHelper
-        ActionController::Base.include ViewComponent::RenderComponentToStringHelper
+          self.check_precompiled_asset = app.config.assets.check_precompiled_asset
+          self.unknown_asset_fallback = app.config.assets.unknown_asset_fallback
+          # Expose the app precompiled asset check to the view
+          self.precompiled_asset_checker = ->(logical_path) { app.asset_precompiled? logical_path }
+        end
       end
-      # :nocov:
     end
 
-    initializer "static assets" do |app|
-      if serve_static_preview_assets?(app.config)
-        app.middleware.use(::ActionDispatch::Static, "#{root}/app/assets/vendor")
+    initializer "view_component.eager_load_actions" do
+      ActiveSupport.on_load(:after_initialize) do
+        ViewComponent::Base.descendants.each(&:__vc_compile) if Rails.application.config.eager_load
       end
     end
 
-    def serve_static_preview_assets?(app_config)
-      app_config.view_component.show_previews && app_config.public_file_server.enabled
-    end
-
     initializer "compiler mode" do |_app|
-      ViewComponent::Compiler.development_mode = (Rails.env.development? || Rails.env.test?)
+      ViewComponent::Compiler.__vc_development_mode = (Rails.env.development? || Rails.env.test?)
     end
 
     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.preview_controller.sub(/Controller$/, "").underscore
+          preview_controller = options.previews.controller.sub(/Controller$/, "").underscore
 
           get(
-            options.preview_route,
+            options.previews.route,
             to: "#{preview_controller}#index",
             as: :preview_view_components,
             internal: true
           )
 
           get(
-            "#{options.preview_route}/*path",
+            "#{options.previews.route}/*path",
             to: "#{preview_controller}#previews",
             as: :preview_view_component,
             internal: true
@@ -174,16 +114,6 @@ module ViewComponent
         end
       end
 
-      # :nocov:
-      if RUBY_VERSION < "3.2.0"
-        ViewComponent::Deprecation.deprecation_warning("Support for Ruby versions < 3.2.0", "ViewComponent v4 will remove support for Ruby versions < 3.2.0 no earlier than April 1, 2025")
-      end
-
-      if Rails.version.to_f < 7.1
-        ViewComponent::Deprecation.deprecation_warning("Support for Rails versions < 7.1", "ViewComponent v4 will remove support for Rails versions < 7.1 no earlier than April 1, 2025")
-      end
-      # :nocov:
-
       app.executor.to_run :before do
         CompileCache.invalidate! unless ActionView::Base.cache_template_loading
       end