view_component 2.63.0 → 2.66.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78c8a36fb19eb4c8a1c3737815113323acc9cd5a9c89a270163ca8336e44c41e
-  data.tar.gz: 6e4135faf54dfc7c519d7ef62080d6e779d04bbbc1efea32b7871fe65bd2c685
+  metadata.gz: 426a776552c0355ba0fb4ccc066c05a218b9998acb39489485375624b347c170
+  data.tar.gz: d17d69cb6e1c08fe31545eb5cf878579dd4aaf11e803790130c83ec7b4c178d2
 SHA512:
-  metadata.gz: 0f207e3d9e6980880876afa36521a3f63abafead81da8d4f5574c9e9164139fbd8029bf8b9eae3f034e2da849541b959025612b21dca548477a38327fe5aa97b
-  data.tar.gz: d65662034f4abf33feeae814b60dcfb82683302be1cf427a5c6f93297a575185963ca8d3a1df81fa9daf7855d25297c303c68e5abc225594be842e12fd657702
+  metadata.gz: 4b001cf58f8586b3e83cf8129c23d0bb5a499182189db4a99dfd747d6767f529a631eb2bf439a32f8a91dbb5861eb16ef637b514bffccacd476d577e2c5c27aa
+  data.tar.gz: 24d147cfbb226ff11114631721507bfed5a73fe25e1963186fe106a9c0f485596b65349457685967e7df0edea4d78841646f36683764244673e4281ff56741fd

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

@@ -10,9 +10,7 @@ module ViewComponent
       around_action :set_locale, only: :previews
       before_action :require_local!, unless: :show_previews?
 
-      if respond_to?(:content_security_policy)
-        content_security_policy(false)
-      end
+      content_security_policy(false) if respond_to?(:content_security_policy)
     end
 
     def index
@@ -45,18 +43,18 @@ module ViewComponent
 
     # :doc:
     def default_preview_layout
-      ViewComponent::Base.default_preview_layout
+      Rails.application.config.view_component.default_preview_layout
     end
 
     # :doc:
     def show_previews?
-      ViewComponent::Base.show_previews
+      Rails.application.config.view_component.show_previews
     end
 
     # :doc:
     def find_preview
       candidates = []
-      params[:path].to_s.scan(%r{/|$}) { candidates << $` }
+      params[:path].to_s.scan(%r{/|$}) { candidates << Regexp.last_match.pre_match }
       preview = candidates.detect { |candidate| ViewComponent::Preview.exists?(candidate) }
 
       if preview
@@ -66,10 +64,8 @@ module ViewComponent
       end
     end
 
-    def set_locale
-      I18n.with_locale(params[:locale] || I18n.default_locale) do
-        yield
-      end
+    def set_locale(&block)
+      I18n.with_locale(params[:locale] || I18n.default_locale, &block)
     end
 
     # Returns either {} or {layout: value} depending on configuration

data/app/helpers/preview_helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PreviewHelper
-  AVAILABLE_PRISM_LANGUAGES = ["ruby", "erb", "haml"]
+  AVAILABLE_PRISM_LANGUAGES = %w[ruby erb haml]
   FALLBACK_LANGUAGE = "ruby"
 
   def preview_source
@@ -22,7 +22,7 @@ module PreviewHelper
       # Fetch template source via finding it through preview paths
       # to accomodate source view when exclusively using templates
       # for previews for Rails < 6.1.
-      all_template_paths = ViewComponent::Base.preview_paths.map do |preview_path|
+      all_template_paths = Rails.application.config.view_component.preview_paths.map do |preview_path|
         Dir.glob("#{preview_path}/**/*")
       end.flatten
 

data/app/views/view_components/preview.html.erb

@@ -1,5 +1,5 @@
 <% if @render_args[:component] %>
-  <% if ViewComponent::Base.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
+  <% if Rails.application.config.view_component.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
     <%= render(@render_args[:component], @render_args[:args], &@render_args[:block]) %>
   <% else %>
     <%= render_component(@render_args[:component], &@render_args[:block]) %>
@@ -8,6 +8,6 @@
   <%= render template: @render_args[:template], locals: @render_args[:locals] || {} %>
 <% end %>
 
-<% if ViewComponent::Base.show_previews_source %>
+<% if Rails.application.config.view_component.show_previews_source %>
   <%= preview_source %>
 <% end %>

data/docs/CHANGELOG.md

@@ -9,6 +9,51 @@ title: Changelog
 
 ## main
 
+## 2.66.0
+
+* Add missing `generate.sidecar`, `generate.stimulus_controller`, `generate.locale`, `generate.distinct_locale_files`, `generate.preview` config options to `config.view_component`.
+
+    *Simon Fish*
+
+## 2.65.0
+
+* Raise `ArgumentError` when conflicting Slots are defined.
+
+    Before this change it was possible to define Slots with conflicting names, for example:
+
+    ```ruby
+    class MyComponent < ViewComponent::Base
+      renders_one :item
+      renders_many :items
+    end
+    ```
+
+    *Joel Hawksley*
+
+## 2.64.0
+
+* Add `warn_on_deprecated_slot_setter` flag to opt-in to deprecation warning.
+
+    In [v2.54.0](https://viewcomponent.org/CHANGELOG.html#2540), the Slots API was updated to require the `with_*` prefix for setting Slots. The non-`with_*` setters will be deprecated in a coming version and removed in `v3.0`.
+
+    To enable the coming deprecation warning, add `warn_on_deprecated_slot_setter`:
+
+    ```ruby
+    class DeprecatedSlotsSetterComponent < ViewComponent::Base
+      warn_on_deprecated_slot_setter
+    end
+    ```
+
+    *Joel Hawksley*
+
+* Add [`m`](https://rubygems.org/gems/m) to development environment.
+
+    *Joel Hawksley*
+
+* Fix potential deadlock scenario in the compiler's development mode.
+
+    *Blake Williams*
+
 ## 2.63.0
 
 * Fixed typo in `renders_many` documentation.

data/lib/rails/generators/abstract_generator.rb

@@ -3,9 +3,7 @@
 module ViewComponent
   module AbstractGenerator
     def copy_view_file
-      unless options["inline"]
-        template "component.html.#{engine_name}", destination
-      end
+      template "component.html.#{engine_name}", destination unless options["inline"]
     end
 
     private
@@ -31,7 +29,7 @@ module ViewComponent
     end
 
     def component_path
-      ViewComponent::Base.view_component_path
+      Rails.application.config.view_component.view_component_path
     end
 
     def stimulus_controller
@@ -44,7 +42,7 @@ module ViewComponent
     end
 
     def sidecar?
-      options["sidecar"] || ViewComponent::Base.generate.sidecar
+      options["sidecar"] || Rails.application.config.view_component.generate.sidecar
     end
   end
 end

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

@@ -13,11 +13,12 @@ module Rails
       check_class_collision suffix: "Component"
 
       class_option :inline, type: :boolean, default: false
-      class_option :locale, type: :boolean, default: ViewComponent::Base.generate.locale
+      class_option :locale, type: :boolean, default: Rails.application.config.view_component.generate.locale
       class_option :parent, type: :string, desc: "The parent class for the generated component"
-      class_option :preview, type: :boolean, default: ViewComponent::Base.generate.preview
+      class_option :preview, type: :boolean, default: Rails.application.config.view_component.generate.preview
       class_option :sidecar, type: :boolean, default: false
-      class_option :stimulus, type: :boolean, default: ViewComponent::Base.generate.stimulus_controller
+      class_option :stimulus, type: :boolean,
+        default: Rails.application.config.view_component.generate.stimulus_controller
 
       def create_component_file
         template "component.rb", File.join(component_path, class_path, "#{file_name}_component.rb")
@@ -40,7 +41,7 @@ module Rails
       def parent_class
         return options[:parent] if options[:parent]
 
-        ViewComponent::Base.component_parent_class || default_parent_class
+        Rails.application.config.view_component.component_parent_class || default_parent_class
       end
 
       def initialize_signature

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

@@ -12,7 +12,7 @@ module Locale
       class_option :sidecar, type: :boolean, default: false
 
       def create_locale_file
-        if ViewComponent::Base.generate.distinct_locale_files
+        if Rails.application.config.view_component.generate.distinct_locale_files
           I18n.available_locales.each do |locale|
             create_file destination(locale), translations_hash([locale]).to_yaml
           end

data/lib/view_component/base.rb

@@ -4,9 +4,9 @@ require "action_view"
 require "active_support/configurable"
 require "view_component/collection"
 require "view_component/compile_cache"
+require "view_component/config"
 require "view_component/content_areas"
 require "view_component/polymorphic_slots"
-require "view_component/previewable"
 require "view_component/slotable"
 require "view_component/slotable_v2"
 require "view_component/translatable"
@@ -14,10 +14,16 @@ require "view_component/with_content_helper"
 
 module ViewComponent
   class Base < ActionView::Base
-    include ActiveSupport::Configurable
+    class << self
+      delegate(*ViewComponent::Config.defaults.keys, to: :config)
+
+      def config
+        Rails.application.config.view_component
+      end
+    end
+
     include ViewComponent::ContentAreas
     include ViewComponent::PolymorphicSlots
-    include ViewComponent::Previewable
     include ViewComponent::SlotableV2
     include ViewComponent::Translatable
     include ViewComponent::WithContentHelper
@@ -113,11 +119,9 @@ module ViewComponent
       @current_template = self
 
       if block && defined?(@__vc_content_set_by_with_content)
-        raise ArgumentError.new(
-          "It looks like a block was provided after calling `with_content` on #{self.class.name}, " \
+        raise ArgumentError, "It looks like a block was provided after calling `with_content` on #{self.class.name}, " \
           "which means that ViewComponent doesn't know which content to use.\n\n" \
           "To fix this issue, use either `with_content` or a block."
-        )
       end
 
       @__vc_content_evaluated = false
@@ -262,9 +266,7 @@ module ViewComponent
     # @private
     def format
       # Ruby 2.6 throws a warning without checking `defined?`, 2.7 doesn't
-      if defined?(@__vc_variant)
-        @__vc_variant
-      end
+      @__vc_variant if defined?(@__vc_variant)
     end
 
     # Use the provided variant instead of the one determined by the current request.
@@ -313,11 +315,9 @@ module ViewComponent
     # config.view_component.test_controller = "MyTestController"
     # ```
     #
-    # Defaults to ApplicationController. Can also be configured on a per-test
-    # basis using `with_controller_class`.
+    # Defaults to `nil`. If this is falsy, `"ApplicationController"` is used. Can also be
+    # configured on a per-test basis using `with_controller_class`.
     #
-    mattr_accessor :test_controller
-    @@test_controller = "ApplicationController"
 
     # Set if render monkey patches should be included or not in Rails <6.1:
     #
@@ -325,7 +325,6 @@ module ViewComponent
     # config.view_component.render_monkey_patch_enabled = false
     # ```
     #
-    mattr_accessor :render_monkey_patch_enabled, instance_writer: false, default: true
 
     # Path for component files
     #
@@ -333,9 +332,8 @@ module ViewComponent
     # config.view_component.view_component_path = "app/my_components"
     # ```
     #
-    # Defaults to `app/components`.
+    # Defaults to `nil`. If this is falsy, `app/components` is used.
     #
-    mattr_accessor :view_component_path, instance_writer: false, default: "app/components"
 
     # Parent class for generated components
     #
@@ -346,7 +344,6 @@ module ViewComponent
     # Defaults to nil. If this is falsy, generators will use
     # "ApplicationComponent" if defined, "ViewComponent::Base" otherwise.
     #
-    mattr_accessor :component_parent_class, instance_writer: false
 
     # Configuration for generators.
     #
@@ -397,7 +394,6 @@ module ViewComponent
     # ```
     #
     #  Defaults to `false`.
-    mattr_accessor :generate, instance_writer: false, default: ActiveSupport::OrderedOptions.new(false)
 
     class << self
       # @private
@@ -489,8 +485,8 @@ module ViewComponent
 
         # 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.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
+        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.
@@ -500,7 +496,7 @@ module ViewComponent
 
         # Removes the first part of the path and the extension.
         child.virtual_path = child.source_location.gsub(
-          %r{(.*#{Regexp.quote(ViewComponent::Base.view_component_path)})|(\.rb)}, ""
+          /(.*#{Regexp.quote(Rails.application.config.view_component.view_component_path)})|(\.rb)/, ""
         )
 
         # Set collection parameter to the extended component
@@ -591,20 +587,16 @@ module ViewComponent
         # parameters will be empty and ViewComponent will not be able to render
         # the component.
         if initialize_parameters.empty?
-          raise ArgumentError.new(
-            "The #{self} initializer is empty or invalid." \
+          raise ArgumentError, "The #{self} 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 https://viewcomponent.org/guide/collections.html for more information on rendering collections."
-          )
         end
 
-        raise ArgumentError.new(
-          "The initializer for #{self} doesn't accept the parameter `#{parameter}`, " \
+        raise ArgumentError, "The initializer for #{self} doesn't accept the parameter `#{parameter}`, " \
           "which is required in order to render it as a collection.\n\n" \
           "To fix this issue, update the initializer to accept `#{parameter}`.\n\n" \
           "See https://viewcomponent.org/guide/collections.html for more information on rendering collections."
-        )
       end
 
       # Ensure the component initializer doesn't define
@@ -614,10 +606,8 @@ module ViewComponent
       def validate_initialization_parameters!
         return unless initialize_parameter_names.include?(RESERVED_PARAMETER)
 
-        raise ViewComponent::ComponentError.new(
-          "#{self} initializer can't accept the parameter `#{RESERVED_PARAMETER}`, as it will override a " \
+        raise ViewComponent::ComponentError, "#{self} initializer can't accept the parameter `#{RESERVED_PARAMETER}`, as it will override a " \
           "public ViewComponent method. To fix this issue, rename the parameter."
-        )
       end
 
       # @private

data/lib/view_component/compiler.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "concurrent-ruby"
+
 module ViewComponent
   class Compiler
     # Lock required to be obtained before compiling the component
@@ -16,7 +18,7 @@ module ViewComponent
 
     def initialize(component_class)
       @component_class = component_class
-      @__vc_compiler_lock = Monitor.new
+      @__vc_compiler_lock = Concurrent::ReadWriteLock.new
     end
 
     def compiled?
@@ -33,7 +35,7 @@ module ViewComponent
 
       component_class.superclass.compile(raise_errors: raise_errors) if should_compile_superclass?
 
-      with_lock do
+      with_write_lock do
         CompileCache.invalidate_class!(component_class)
 
         subclass_instance_methods = component_class.instance_methods(false)
@@ -90,14 +92,18 @@ module ViewComponent
       end
     end
 
-    def with_lock(&block)
+    def with_write_lock(&block)
       if development?
-        __vc_compiler_lock.synchronize(&block)
+        __vc_compiler_lock.with_write_lock(&block)
       else
         block.call
       end
     end
 
+    def with_read_lock(&block)
+      __vc_compiler_lock.with_read_lock(&block)
+    end
+
     private
 
     attr_reader :component_class
@@ -123,7 +129,7 @@ module ViewComponent
       if development?
         component_class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def render_template_for(variant = nil)
-          self.class.compiler.with_lock do
+          self.class.compiler.with_read_lock do
             #{body}
           end
         end

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/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::Config.default
 
     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|
@@ -72,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
 
@@ -94,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
@@ -116,7 +101,7 @@ 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
@@ -160,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

@@ -61,10 +61,12 @@ module ViewComponent
             end
 
           define_method(setter_name) do |*args, &block|
-            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."
-            )
+            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

data/lib/view_component/render_preview_helper.rb

@@ -22,9 +22,7 @@ module ViewComponent
     def render_preview(name)
       begin
         preview_klass = if respond_to?(:described_class)
-          if described_class.nil?
-            raise "`render_preview` expected a described_class, but it is nil."
-          end
+          raise "`render_preview` expected a described_class, but it is nil." if described_class.nil?
 
           "#{described_class}Preview"
         else
@@ -32,12 +30,10 @@ module ViewComponent
         end
         preview_klass = preview_klass.constantize
       rescue NameError
-        raise NameError.new(
-          "`render_preview` expected to find #{preview_klass}, but it does not exist."
-        )
+        raise NameError, "`render_preview` expected to find #{preview_klass}, but it does not exist."
       end
 
-      previews_controller = build_controller(ViewComponent::Base.preview_controller.constantize)
+      previews_controller = build_controller(Rails.application.config.view_component.preview_controller.constantize)
       previews_controller.request.params[:path] = "#{preview_klass.preview_name}/#{name}"
       previews_controller.response = ActionDispatch::Response.new
       result = previews_controller.previews

data/lib/view_component/slotable_v2.rb

@@ -17,9 +17,19 @@ module ViewComponent
       # Hash of registered Slots
       class_attribute :registered_slots
       self.registered_slots = {}
+
+      class_attribute :_warn_on_deprecated_slot_setter
+      self._warn_on_deprecated_slot_setter = false
     end
 
     class_methods do
+      ##
+      # Enables deprecations coming to the Slots API in ViewComponent v3
+      #
+      def warn_on_deprecated_slot_setter
+        self._warn_on_deprecated_slot_setter = true
+      end
+
       ##
       # Registers a sub-component
       #
@@ -70,6 +80,7 @@ module ViewComponent
       #   <% end %>
       def renders_one(slot_name, callable = nil)
         validate_singular_slot_name(slot_name)
+        validate_plural_slot_name(ActiveSupport::Inflector.pluralize(slot_name).to_sym)
 
         define_method :"with_#{slot_name}" do |*args, &block|
           set_slot(slot_name, nil, *args, &block)
@@ -80,7 +91,13 @@ module ViewComponent
           if args.empty? && block.nil?
             get_slot(slot_name)
           else
-            # Deprecated: Will remove in 3.0
+            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."
+              )
+            end
+
             set_slot(slot_name, nil, *args, &block)
           end
         end
@@ -131,16 +148,22 @@ module ViewComponent
       #     <% end %>
       #   <% end %>
       def renders_many(slot_name, callable = nil)
-        validate_plural_slot_name(slot_name)
-
         singular_name = ActiveSupport::Inflector.singularize(slot_name)
+        validate_plural_slot_name(slot_name)
+        validate_singular_slot_name(ActiveSupport::Inflector.singularize(slot_name).to_sym)
 
         # Define setter for singular names
         # for example `renders_many :items` allows fetching all tabs with
         # `component.tabs` and setting a tab with `component.tab`
-        #
-        # Deprecated: Will remove in 3.0
+
         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."
+            )
+          end
+
           set_slot(slot_name, nil, *args, &block)
         end
         ruby2_keywords(singular_name.to_sym) if respond_to?(:ruby2_keywords, true)
@@ -162,7 +185,13 @@ module ViewComponent
           if collection_args.nil? && block.nil?
             get_slot(slot_name)
           else
-            # Deprecated: Will remove in 3.0
+            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."
+              )
+            end
+
             collection_args.map do |args|
               set_slot(slot_name, nil, **args, &block)
             end

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 63
+    MINOR = 66
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

data/lib/view_component.rb

@@ -10,6 +10,7 @@ module ViewComponent
   autoload :Compiler
   autoload :CompileCache
   autoload :ComponentError
+  autoload :Config
   autoload :Deprecation
   autoload :Instrumentation
   autoload :Preview

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.63.0
+  version: 2.66.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-08-01 00:00:00.000000000 Z
+date: 2022-08-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +156,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -329,6 +357,7 @@ files:
 - lib/view_component/compile_cache.rb
 - lib/view_component/compiler.rb
 - lib/view_component/component_error.rb
+- lib/view_component/config.rb
 - lib/view_component/content_areas.rb
 - lib/view_component/deprecation.rb
 - lib/view_component/docs_builder_component.html.erb
@@ -338,7 +367,6 @@ files:
 - lib/view_component/polymorphic_slots.rb
 - lib/view_component/preview.rb
 - lib/view_component/preview_template_error.rb
-- lib/view_component/previewable.rb
 - lib/view_component/rails/tasks/view_component.rake
 - lib/view_component/render_component_helper.rb
 - lib/view_component/render_component_to_string_helper.rb

data/lib/view_component/previewable.rb

@@ -1,62 +0,0 @@
-# frozen_string_literal: true
-
-require "active_support/concern"
-
-module ViewComponent
-  module Previewable
-    extend ActiveSupport::Concern
-
-    included do
-      # Enable or disable component previews:
-      #
-      #     config.view_component.show_previews = true
-      #
-      # Defaults to `true` in development.
-      #
-      mattr_accessor :show_previews, instance_writer: false
-
-      # Enable or disable source code previews in component previews:
-      #
-      #     config.view_component.show_previews_source = true
-      #
-      # Defaults to `false`.
-      #
-      mattr_accessor :show_previews_source, instance_writer: false, default: false
-
-      # Set a custom default layout used for preview index and individual previews:
-      #
-      #     config.view_component.default_preview_layout = "component_preview"
-      #
-      mattr_accessor :default_preview_layout, instance_writer: false
-
-      # Set the location of component previews:
-      #
-      #     config.view_component.preview_paths << "#{Rails.root}/lib/component_previews"
-      #
-      mattr_accessor :preview_paths, instance_writer: false
-
-      # @deprecated Use `preview_paths` instead. Will be removed in v3.0.0.
-      mattr_accessor :preview_path, instance_writer: false
-
-      # Set the entry route for component previews:
-      #
-      #     config.view_component.preview_route = "/previews"
-      #
-      # Defaults to `/rails/view_components` when `show_previews` is enabled.
-      #
-      mattr_accessor :preview_route, instance_writer: false do
-        "/rails/view_components"
-      end
-
-      # Set the controller used for previewing components:
-      #
-      #     config.view_component.preview_controller = "MyPreviewController"
-      #
-      # Defaults to `ViewComponentsController`.
-      #
-      mattr_accessor :preview_controller, instance_writer: false do
-        "ViewComponentsController"
-      end
-    end
-  end
-end