view_component 2.50.0 → 2.69.0

data/lib/view_component/config.rb

@@ -0,0 +1,159 @@
+# frozen_string_literal: true
+
+require "view_component/deprecation"
+
+module ViewComponent
+  class Config
+    class << self
+      # `new` without any arguments initializes the default configuration, but
+      # it's important to differentiate in case that's no longer the case in
+      # future.
+      alias_method :default, :new
+
+      def defaults
+        ActiveSupport::OrderedOptions.new.merge!({
+          generate: ActiveSupport::OrderedOptions.new(false),
+          preview_controller: "ViewComponentsController",
+          preview_route: "/rails/view_components",
+          show_previews_source: false,
+          instrumentation_enabled: false,
+          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
+        })
+      end
+
+      # @!attribute generate
+      # @return [ActiveSupport::OrderedOptions]
+      # The subset of configuration options relating to generators.
+      #
+      # All options under this namespace default to `false` unless otherwise
+      # stated.
+      #
+      # #### #sidecar
+      #
+      # Always generate a component with a sidecar directory:
+      #
+      #     config.view_component.generate.sidecar = true
+      #
+      # #### #stimulus_controller
+      #
+      # Always generate a Stimulus controller alongside the component:
+      #
+      #     config.view_component.generate.stimulus_controller = true
+      #
+      # #### #locale
+      #
+      # Always generate translations file alongside the component:
+      #
+      #     config.view_component.generate.locale = true
+      #
+      # #### #distinct_locale_files
+      #
+      # Always generate as many translations files as available locales:
+      #
+      #     config.view_component.generate.distinct_locale_files = true
+      #
+      # One file will be generated for each configured `I18n.available_locales`,
+      # falling back to `[:en]` when no `available_locales` is defined.
+      #
+      # #### #preview
+      #
+      # Always generate a preview alongside the component:
+      #
+      #      config.view_component.generate.preview = true
+
+      # @!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 instrumentation_enabled
+      # @return [Boolean]
+      # Whether ActiveSupport notifications are enabled.
+      # Defaults to `false`.
+
+      # @!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/component/previews']` relative to your Rails root.
+
+      # @!attribute preview_path
+      # @deprecated Use #preview_paths instead. Will be removed in v3.0.0.
+
+      # @!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.
+
+      def default_preview_paths
+        return [] unless defined?(Rails.root) && Dir.exist?("#{Rails.root}/test/components/previews")
+
+        ["#{Rails.root}/test/components/previews"]
+      end
+    end
+
+    def initialize
+      @config = self.class.defaults
+    end
+
+    def preview_path
+      preview_paths
+    end
+
+    def preview_path=(new_value)
+      ViewComponent::Deprecation.warn("`preview_path` will be removed in v3.0.0. Use `preview_paths` instead.")
+      self.preview_paths = Array.wrap(new_value)
+    end
+
+    delegate_missing_to :config
+
+    private
+
+    attr_reader :config
+  end
+end

data/lib/view_component/content_areas.rb

@@ -21,7 +21,7 @@ module ViewComponent
         )
       end
 
-      if block_given?
+      if block
         content = view_context.capture(&block)
       end
 

data/lib/view_component/docs_builder_component.rb

@@ -28,7 +28,7 @@ module ViewComponent
       end
 
       def types
-        " → [#{@method.tag(:return).types.join(',')}]" if @method.tag(:return)&.types && show_types?
+        " → [#{@method.tag(:return).types.join(",")}]" if @method.tag(:return)&.types && show_types?
       end
 
       def signature_or_name

data/lib/view_component/engine.rb

@@ -1,11 +1,11 @@
 # frozen_string_literal: true
 
 require "rails"
+require "view_component/base"
 
 module ViewComponent
   class Engine < Rails::Engine # :nodoc:
-    config.view_component = ActiveSupport::OrderedOptions.new
-    config.view_component.preview_paths ||= []
+    config.view_component = ViewComponent::Base.config
 
     rake_tasks do
       load "view_component/rails/tasks/view_component.rake"
@@ -14,25 +14,20 @@ module ViewComponent
     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|
+        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.show_previews_source ||= ViewComponent::Base.show_previews_source
       options.instrumentation_enabled = false if options.instrumentation_enabled.nil?
-      options.preview_route ||= ViewComponent::Base.preview_route
-      options.preview_controller ||= ViewComponent::Base.preview_controller
 
       if options.show_previews
+        # 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?(
           "#{Rails.root}/test/components/previews"
         )
 
-        if options.preview_path.present?
-          ViewComponent::Deprecation.warn(
-            "`preview_path` will be removed in v3.0.0. Use `preview_paths` instead."
-          )
-          options.preview_paths << options.preview_path
-        end
-
         if options.show_previews_source
           require "method_source"
 
@@ -41,10 +36,6 @@ module ViewComponent
           end
         end
       end
-
-      ActiveSupport.on_load(:view_component) do
-        options.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
-      end
     end
 
     initializer "view_component.enable_instrumentation" do |app|
@@ -61,7 +52,8 @@ module ViewComponent
       options = app.config.view_component
 
       if options.show_previews && !options.preview_paths.empty?
-        ActiveSupport::Dependencies.autoload_paths.concat(options.preview_paths)
+        paths_to_add = options.preview_paths - ActiveSupport::Dependencies.autoload_paths
+        ActiveSupport::Dependencies.autoload_paths.concat(paths_to_add) if paths_to_add.any?
       end
     end
 
@@ -71,12 +63,6 @@ module ViewComponent
       end
     end
 
-    initializer "view_component.compile_config_methods" do
-      ActiveSupport.on_load(:view_component) do
-        config.compile_methods! if config.respond_to?(:compile_methods!)
-      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
 
@@ -93,7 +79,7 @@ module ViewComponent
       end
     end
 
-    initializer "view_component.include_render_component" do |app|
+    initializer "view_component.include_render_component" do |_app|
       next if Rails.version.to_f >= 6.1
 
       ActiveSupport.on_load(:action_view) do
@@ -115,12 +101,12 @@ module ViewComponent
       end
     end
 
-    initializer "compiler mode" do |app|
+    initializer "compiler mode" do |_app|
       ViewComponent::Compiler.mode = if Rails.env.development? || Rails.env.test?
-                                       ViewComponent::Compiler::DEVELOPMENT_MODE
-                                     else
-                                       ViewComponent::Compiler::PRODUCTION_MODE
-                                     end
+        ViewComponent::Compiler::DEVELOPMENT_MODE
+      else
+        ViewComponent::Compiler::PRODUCTION_MODE
+      end
     end
 
     config.after_initialize do |app|
@@ -159,7 +145,7 @@ unless defined?(ViewComponent::Base)
 
   ViewComponent::Deprecation.warn(
     "This manually engine loading is deprecated and will be removed in v3.0.0. " \
-    "Remove `require \"view_component/engine\"`."
+    'Remove `require "view_component/engine"`.'
   )
 
   require "view_component"

data/lib/view_component/polymorphic_slots.rb

@@ -5,6 +5,17 @@ module ViewComponent
     # In older rails versions, using a concern isn't a good idea here because they appear to not work with
     # Module#prepend and class methods.
     def self.included(base)
+      if base != ViewComponent::Base
+        # :nocov:
+        location = Kernel.caller_locations(1, 1)[0]
+
+        warn(
+          "warning: ViewComponent::PolymorphicSlots is now included in ViewComponent::Base by default " \
+          "and can be removed from #{location.path}:#{location.lineno}"
+        )
+        # :nocov:
+      end
+
       base.singleton_class.prepend(ClassMethods)
       base.include(InstanceMethods)
     end
@@ -31,6 +42,10 @@ module ViewComponent
           define_method(getter_name) do
             get_slot(slot_name)
           end
+
+          define_method("#{getter_name}?") do
+            get_slot(slot_name).present?
+          end
         end
 
         renderable_hash = types.each_with_object({}) do |(poly_type, poly_callable), memo|
@@ -46,12 +61,24 @@ module ViewComponent
             end
 
           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."
+              )
+            end
+
             set_polymorphic_slot(slot_name, poly_type, *args, &block)
           end
           ruby2_keywords(setter_name.to_sym) if respond_to?(:ruby2_keywords, true)
+
+          define_method("with_#{setter_name}") do |*args, &block|
+            set_polymorphic_slot(slot_name, poly_type, *args, &block)
+          end
+          ruby2_keywords(:"with_#{setter_name}") if respond_to?(:ruby2_keywords, true)
         end
 
-        self.registered_slots[slot_name] = {
+        registered_slots[slot_name] = {
           collection: collection,
           renderable_hash: renderable_hash
         }

data/lib/view_component/preview.rb

@@ -14,7 +14,7 @@ module ViewComponent # :nodoc:
         block: block,
         component: component,
         locals: {},
-        template: "view_components/preview",
+        template: "view_components/preview"
       }
     end
 
@@ -30,7 +30,8 @@ module ViewComponent # :nodoc:
     class << self
       # Returns all component preview classes.
       def all
-        load_previews if descendants.empty?
+        load_previews
+
         descendants
       end
 
@@ -65,10 +66,12 @@ module ViewComponent # :nodoc:
         name.chomp("Preview").underscore
       end
 
+      # rubocop:disable Style/TrivialAccessors
       # Setter for layout name.
       def layout(layout_name)
         @layout = layout_name
       end
+      # rubocop:enable Style/TrivialAccessors
 
       # Returns the relative path (from preview_path) to the preview example template if the template exists
       def preview_example_template_path(example)
@@ -86,26 +89,26 @@ module ViewComponent # :nodoc:
         end
 
         path = Dir["#{preview_path}/#{preview_name}_preview/#{example}.html.*"].first
-        Pathname.new(path).
-          relative_path_from(Pathname.new(preview_path)).
-          to_s.
-          sub(/\..*$/, "")
+        Pathname.new(path)
+          .relative_path_from(Pathname.new(preview_path))
+          .to_s
+          .sub(/\..*$/, "")
       end
 
       # Returns the method body for the example from the preview file.
       def preview_source(example)
-        source = self.instance_method(example.to_sym).source.split("\n")
+        source = instance_method(example.to_sym).source.split("\n")
         source[1...(source.size - 1)].join("\n")
       end
 
-      private
-
       def load_previews
         Array(preview_paths).each do |preview_path|
           Dir["#{preview_path}/**/*_preview.rb"].sort.each { |file| require_dependency file }
         end
       end
 
+      private
+
       def preview_paths
         Base.preview_paths
       end

data/lib/view_component/render_component_helper.rb

@@ -3,6 +3,7 @@
 module ViewComponent
   module RenderComponentHelper # :nodoc:
     def render_component(component, &block)
+      component.set_original_view_context(__vc_original_view_context) if is_a?(ViewComponent::Base)
       component.render_in(self, &block)
     end
   end

data/lib/view_component/render_component_to_string_helper.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module RenderComponentToStringHelper # :nodoc:
     def render_component_to_string(component)
-      component.render_in(self.view_context)
+      component.render_in(view_context)
     end
   end
 end

data/lib/view_component/render_to_string_monkey_patch.rb

@@ -4,7 +4,7 @@ module ViewComponent
   module RenderToStringMonkeyPatch # :nodoc:
     def render_to_string(options = {}, args = {})
       if options.respond_to?(:render_in)
-        options.render_in(self.view_context)
+        options.render_in(view_context)
       else
         super
       end

data/lib/view_component/rendering_component_helper.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module RenderingComponentHelper # :nodoc:
     def render_component(component)
-      self.response_body = component.render_in(self.view_context)
+      self.response_body = component.render_in(view_context)
     end
   end
 end

data/lib/view_component/rendering_monkey_patch.rb

@@ -4,7 +4,7 @@ module ViewComponent
   module RenderingMonkeyPatch # :nodoc:
     def render(options = {}, args = {})
       if options.respond_to?(:render_in)
-        self.response_body = options.render_in(self.view_context)
+        self.response_body = options.render_in(view_context)
       else
         super
       end

data/lib/view_component/slot_v2.rb

@@ -45,18 +45,12 @@ module ViewComponent
           if defined?(@__vc_content_set_by_with_content)
             @__vc_component_instance.with_content(@__vc_content_set_by_with_content)
 
-            view_context.capture do
-              @__vc_component_instance.render_in(view_context)
-            end
+            @__vc_component_instance.render_in(view_context)
           elsif defined?(@__vc_content_block)
-            view_context.capture do
-              # render_in is faster than `parent.render`
-              @__vc_component_instance.render_in(view_context, &@__vc_content_block)
-            end
+            # render_in is faster than `parent.render`
+            @__vc_component_instance.render_in(view_context, &@__vc_content_block)
           else
-            view_context.capture do
-              @__vc_component_instance.render_in(view_context)
-            end
+            @__vc_component_instance.render_in(view_context)
           end
         elsif defined?(@__vc_content)
           @__vc_content

data/lib/view_component/slotable.rb

@@ -30,7 +30,7 @@ module ViewComponent
 
         slot_names.each do |slot_name|
           # Ensure slot_name isn't already declared
-          if self.slots.key?(slot_name)
+          if slots.key?(slot_name)
             raise ArgumentError.new("#{slot_name} slot declared multiple times")
           end
 
@@ -73,7 +73,7 @@ module ViewComponent
           class_name = "ViewComponent::Slot" unless class_name.present?
 
           # Register the slot on the component
-          self.slots[slot_name] = {
+          slots[slot_name] = {
             class_name: class_name,
             instance_variable_name: instance_variable_name,
             collection: collection
@@ -84,7 +84,7 @@ module ViewComponent
       def inherited(child)
         # Clone slot configuration into child class
         # see #test_slots_pollution
-        child.slots = self.slots.clone
+        child.slots = slots.clone
 
         super
       end
@@ -106,7 +106,7 @@ module ViewComponent
     #
     def slot(slot_name, **args, &block)
       # Raise ArgumentError if `slot` doesn't exist
-      unless slots.keys.include?(slot_name)
+      unless slots.key?(slot_name)
         raise ArgumentError.new "Unknown slot '#{slot_name}' - expected one of '#{slots.keys}'"
       end
 
@@ -123,8 +123,7 @@ module ViewComponent
       slot_instance = args.present? ? slot_class.new(**args) : slot_class.new
 
       # Capture block and assign to slot_instance#content
-      # rubocop:disable Rails/OutputSafety
-      slot_instance.content = view_context.capture(&block).to_s.strip.html_safe if block_given?
+      slot_instance.content = view_context.capture(&block).to_s.strip.html_safe if block
 
       if slot[:collection]
         # Initialize instance variable as an empty array