view_component 4.0.0.alpha5 → 4.0.0.alpha7

data/lib/view_component/config.rb

@@ -13,14 +13,8 @@ module ViewComponent
       def defaults
         ActiveSupport::OrderedOptions.new.merge!({
           generate: default_generate_options,
-          preview_controller: "ViewComponentsController",
-          preview_route: "/rails/view_components",
-          instrumentation_enabled: false,
-          component_parent_class: nil,
-          show_previews: Rails.env.development? || Rails.env.test?,
-          preview_paths: default_preview_paths,
-          test_controller: "ApplicationController",
-          default_preview_layout: nil
+          previews: default_previews_options,
+          instrumentation_enabled: false
         })
       end
 
@@ -84,7 +78,7 @@ 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`
@@ -100,49 +94,40 @@ module ViewComponent
       # `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 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 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.
-
       def default_preview_paths
         (default_rails_preview_paths + default_rails_engines_preview_paths).uniq
       end
@@ -173,6 +158,16 @@ module ViewComponent
         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
 
     # @!attribute current

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

@@ -11,15 +11,15 @@ module ViewComponent
     initializer "view_component.set_configs" do |app|
       options = app.config.view_component
 
-      %i[generate preview_controller preview_route].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.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"
         )
       end
@@ -36,8 +36,8 @@ module ViewComponent
     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
@@ -88,19 +88,19 @@ 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.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

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

@@ -9,7 +9,7 @@ module ViewComponent # :nodoc:
       def method_missing(method, *args)
         return super if !method.end_with?("_template")
 
-        if @__vc_inline_template_defined
+        if defined?(@__vc_inline_template_defined) && @__vc_inline_template_defined
           raise MultipleInlineTemplatesError
         end
 
@@ -37,12 +37,12 @@ module ViewComponent # :nodoc:
         method.end_with?("_template") || super
       end
 
-      def inline_template
-        @__vc_inline_template
+      def __vc_inline_template
+        @__vc_inline_template if defined?(@__vc_inline_template)
       end
 
       def __vc_inline_template_language
-        @__vc_inline_template_language
+        @__vc_inline_template_language if defined?(@__vc_inline_template_language)
       end
 
       def inherited(subclass)

data/lib/view_component/preview.rb

@@ -102,7 +102,7 @@ module ViewComponent # :nodoc:
       private
 
       def preview_paths
-        Base.preview_paths
+        Base.previews.paths
       end
     end
   end

data/lib/view_component/slot.rb

@@ -9,18 +9,13 @@ module ViewComponent
     attr_writer :__vc_component_instance, :__vc_content_block, :__vc_content
 
     def initialize(parent)
-      @content = nil
-      @__vc_component_instance = nil
-      @__vc_content = nil
-      @__vc_content_block = nil
-      @__vc_content_set_by_with_content = nil
       @parent = parent
     end
 
     def content?
-      return true if @__vc_content.present?
-      return true if @__vc_content_set_by_with_content.present?
-      return true if @__vc_content_block.present?
+      return true if defined?(@__vc_content) && @__vc_content.present?
+      return true if defined?(@__vc_content_set_by_with_content) && @__vc_content_set_by_with_content.present?
+      return true if defined?(@__vc_content_block) && @__vc_content_block.present?
       return false if !__vc_component_instance?
 
       @__vc_component_instance.content?
@@ -48,11 +43,11 @@ module ViewComponent
     # If there is no slot renderable, we evaluate the block passed to
     # the slot and return it.
     def to_s
-      return @content if !@content.nil?
+      return @content if defined?(@content)
 
       view_context = @parent.send(:view_context)
 
-      if !@__vc_content_block.nil? && !@__vc_content_set_by_with_content.nil? && !@__vc_content_set_by_with_content.nil?
+      if defined?(@__vc_content_block) && defined?(@__vc_content_set_by_with_content)
         raise DuplicateSlotContentError.new(self.class.name)
       end
 
@@ -60,7 +55,7 @@ module ViewComponent
         if __vc_component_instance?
           @__vc_component_instance.__vc_original_view_context = @parent.__vc_original_view_context
 
-          if !@__vc_content_block.nil?
+          if defined?(@__vc_content_block)
             # render_in is faster than `parent.render`
             @__vc_component_instance.render_in(view_context) do |*args|
               @__vc_content_block.call(*args)
@@ -68,11 +63,11 @@ module ViewComponent
           else
             @__vc_component_instance.render_in(view_context)
           end
-        elsif !@__vc_content.nil?
+        elsif defined?(@__vc_content)
           @__vc_content
-        elsif !@__vc_content_block.nil?
+        elsif defined?(@__vc_content_block)
           view_context.capture(&@__vc_content_block)
-        elsif !@__vc_content_set_by_with_content.nil?
+        elsif defined?(@__vc_content_set_by_with_content)
           @__vc_content_set_by_with_content
         end
 
@@ -113,7 +108,7 @@ module ViewComponent
     private
 
     def __vc_component_instance?
-      !@__vc_component_instance.nil?
+      defined?(@__vc_component_instance)
     end
   end
 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,10 +211,12 @@ 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|
-          config[:default_method] = instance_methods.find { |method_name| method_name == :"default_#{slot_name}" }
+          default_method_name = :"default_#{slot_name}"
+          config[:default_method] = instance_methods.find { |method_name| method_name == default_method_name }
 
           registered_slots[slot_name] = config
         end
@@ -222,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|
@@ -251,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
           )
 
@@ -262,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|
@@ -278,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
 
@@ -301,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
@@ -321,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)
@@ -350,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]
@@ -375,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)
 
@@ -420,6 +422,8 @@ module ViewComponent
         end
       end
 
+      @__vc_set_slots ||= {}
+
       if slot_definition[:collection]
         @__vc_set_slots[slot_name] ||= []
         @__vc_set_slots[slot_name].push(slot)
@@ -430,16 +434,16 @@ 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] && @__vc_set_slots[slot_name]
+      if !slot_definition[:collection] && defined?(@__vc_set_slots) && @__vc_set_slots[slot_name]
         raise ContentAlreadySetForPolymorphicSlotError.new(slot_name)
       end
 
       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/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

data/lib/view_component/test_helpers.rb

@@ -73,7 +73,7 @@ module ViewComponent
     # @param params [Hash] Parameters to be passed to the preview.
     # @return [Nokogiri::HTML5]
     def render_preview(name, from: __vc_test_helpers_preview_class, params: {})
-      previews_controller = __vc_test_helpers_build_controller(Rails.application.config.view_component.preview_controller.constantize)
+      previews_controller = __vc_test_helpers_build_controller(Rails.application.config.view_component.previews.controller.constantize)
 
       # From what I can tell, it's not possible to overwrite all request parameters
       # at once, so we set them individually here.
@@ -233,7 +233,20 @@ module ViewComponent
     #
     # @return [ActionController::Base]
     def vc_test_controller
-      @vc_test_controller ||= __vc_test_helpers_build_controller(Base.test_controller.constantize)
+      @vc_test_controller ||= __vc_test_helpers_build_controller(vc_test_controller_class)
+    end
+
+    # Set the controller used by `render_inline`:
+    #
+    # ```ruby
+    # def vc_test_controller_class
+    #   MyTestController
+    # end
+    # ```
+    def vc_test_controller_class
+      return @__vc_test_controller_class if defined?(@__vc_test_controller_class)
+
+      defined?(ApplicationController) ? ApplicationController : ActionController::Base
     end
 
     # Access the request used by `render_inline`: