view_component 3.10.0 → 3.23.2

data/lib/view_component/preview.rb

@@ -102,7 +102,7 @@ module ViewComponent # :nodoc:
 
       def load_previews
         Array(preview_paths).each do |preview_path|
-          Dir["#{preview_path}/**/*_preview.rb"].sort.each { |file| require_dependency file }
+          Dir["#{preview_path}/**/*preview.rb"].sort.each { |file| require_dependency file }
         end
       end
 

data/lib/view_component/rails/tasks/view_component.rake

@@ -7,8 +7,14 @@ namespace :view_component do
     # :nocov:
     require "rails/code_statistics"
 
-    dir = ViewComponent::Base.view_component_path
-    ::STATS_DIRECTORIES << ["ViewComponents", dir] if File.directory?(Rails.root + dir)
+    if Rails.root.join(ViewComponent::Base.view_component_path).directory?
+      ::STATS_DIRECTORIES << ["ViewComponents", ViewComponent::Base.view_component_path]
+    end
+
+    if Rails.root.join("test/components").directory?
+      ::STATS_DIRECTORIES << ["ViewComponent tests", "test/components"]
+      CodeStatistics::TEST_TYPES << "ViewComponent tests"
+    end
     # :nocov:
   end
 end

data/lib/view_component/slot.rb

@@ -57,7 +57,17 @@ module ViewComponent
 
           if defined?(@__vc_content_block)
             # render_in is faster than `parent.render`
-            @__vc_component_instance.render_in(view_context, &@__vc_content_block)
+            @__vc_component_instance.render_in(view_context) do |*args|
+              return @__vc_content_block.call(*args) if @__vc_content_block&.source_location.nil?
+
+              block_context = @__vc_content_block.binding.receiver
+
+              if block_context.class < ActionView::Base
+                block_context.capture(*args, &@__vc_content_block)
+              else
+                @__vc_content_block.call(*args)
+              end
+            end
           else
             @__vc_component_instance.render_in(view_context)
           end

data/lib/view_component/slotable.rb

@@ -89,11 +89,11 @@ module ViewComponent
           end
           ruby2_keywords(setter_method_name) if respond_to?(:ruby2_keywords, true)
 
-          define_method slot_name do
+          self::GeneratedSlotMethods.define_method slot_name do
             get_slot(slot_name)
           end
 
-          define_method :"#{slot_name}?" do
+          self::GeneratedSlotMethods.define_method :"#{slot_name}?" do
             get_slot(slot_name).present?
           end
 
@@ -176,11 +176,11 @@ module ViewComponent
             end
           end
 
-          define_method slot_name do
+          self::GeneratedSlotMethods.define_method slot_name do
             get_slot(slot_name)
           end
 
-          define_method :"#{slot_name}?" do
+          self::GeneratedSlotMethods.define_method :"#{slot_name}?" do
             get_slot(slot_name).present?
           end
 
@@ -199,19 +199,28 @@ module ViewComponent
         end
       end
 
-      # Clone slot configuration into child class
-      # see #test_slots_pollution
       def inherited(child)
+        # Clone slot configuration into child class
+        # see #test_slots_pollution
         child.registered_slots = registered_slots.clone
+
+        # Add a module for slot methods, allowing them to be overriden by the component class
+        # see #test_slot_name_can_be_overriden
+        unless child.const_defined?(:GeneratedSlotMethods, false)
+          generated_slot_methods = Module.new
+          child.const_set(:GeneratedSlotMethods, generated_slot_methods)
+          child.include generated_slot_methods
+        end
+
         super
       end
 
       def register_polymorphic_slot(slot_name, types, collection:)
-        define_method(slot_name) do
+        self::GeneratedSlotMethods.define_method(slot_name) do
           get_slot(slot_name)
         end
 
-        define_method(:"#{slot_name}?") do
+        self::GeneratedSlotMethods.define_method(:"#{slot_name}?") do
           get_slot(slot_name).present?
         end
 
@@ -259,6 +268,15 @@ module ViewComponent
         }
       end
 
+      # Called by the compiler, as instance methods are not defined when slots are first registered
+      def register_default_slots
+        registered_slots.each do |slot_name, config|
+          config[:default_method] = instance_methods.find { |method_name| method_name == :"default_#{slot_name}" }
+
+          registered_slots[slot_name] = config
+        end
+      end
+
       private
 
       def register_slot(slot_name, **kwargs)
@@ -266,10 +284,7 @@ module ViewComponent
       end
 
       def define_slot(slot_name, collection:, callable:)
-        # Setup basic slot data
-        slot = {
-          collection: collection
-        }
+        slot = {collection: collection}
         return slot unless callable
 
         # If callable responds to `render_in`, we set it on the slot as a renderable
@@ -318,7 +333,6 @@ module ViewComponent
 
       def raise_if_slot_registered(slot_name)
         if registered_slots.key?(slot_name)
-          # TODO remove? This breaks overriding slots when slots are inherited
           raise RedefinedSlotError.new(name, slot_name)
         end
       end
@@ -366,7 +380,7 @@ module ViewComponent
       # 1. If this is a `content_area` style sub-component, we will render the
       # block via the `slot`
       #
-      # 2. Since we've to pass block content to components when calling
+      # 2. Since we have to pass block content to components when calling
       # `render`, evaluating the block here would require us to call
       # `view_context.capture` twice, which is slower
       slot.__vc_content_block = block if block
@@ -417,7 +431,7 @@ module ViewComponent
     def set_polymorphic_slot(slot_name, poly_type = nil, *args, &block)
       slot_definition = self.class.registered_slots[slot_name]
 
-      if !slot_definition[:collection] && (defined?(@__vc_set_slots) && @__vc_set_slots[slot_name])
+      if !slot_definition[:collection] && defined?(@__vc_set_slots) && @__vc_set_slots[slot_name]
         raise ContentAlreadySetForPolymorphicSlotError.new(slot_name)
       end
 

data/lib/view_component/slotable_default.rb

@@ -0,0 +1,20 @@
+module ViewComponent
+  module SlotableDefault
+    def get_slot(slot_name)
+      @__vc_set_slots ||= {}
+
+      return super unless !@__vc_set_slots[slot_name] && (default_method = registered_slots[slot_name][:default_method])
+
+      renderable_value = send(default_method)
+      slot = Slot.new(self)
+
+      if renderable_value.respond_to?(:render_in)
+        slot.__vc_component_instance = renderable_value
+      else
+        slot.__vc_content = renderable_value
+      end
+
+      slot
+    end
+  end
+end

data/lib/view_component/template.rb

@@ -0,0 +1,134 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  class Template
+    DataWithSource = Struct.new(:format, :identifier, :short_identifier, :type, keyword_init: true)
+    DataNoSource = Struct.new(:source, :identifier, :type, keyword_init: true)
+
+    attr_reader :variant, :this_format, :type
+
+    def initialize(
+      component:,
+      type:,
+      this_format: nil,
+      variant: nil,
+      lineno: nil,
+      path: nil,
+      extension: nil,
+      source: nil,
+      method_name: nil,
+      defined_on_self: true
+    )
+      @component = component
+      @type = type
+      @this_format = this_format
+      @variant = variant&.to_sym
+      @lineno = lineno
+      @path = path
+      @extension = extension
+      @source = source
+      @method_name = method_name
+      @defined_on_self = defined_on_self
+
+      @source_originally_nil = @source.nil?
+
+      @call_method_name =
+        if @method_name
+          @method_name
+        else
+          out = +"call"
+          out << "_#{normalized_variant_name}" if @variant.present?
+          out << "_#{@this_format}" if @this_format.present? && @this_format != ViewComponent::Base::VC_INTERNAL_DEFAULT_FORMAT
+          out
+        end
+    end
+
+    def compile_to_component
+      if !inline_call?
+        @component.silence_redefinition_of_method(@call_method_name)
+
+        # rubocop:disable Style/EvalWithLocation
+        @component.class_eval <<-RUBY, @path, @lineno
+        def #{@call_method_name}
+          #{compiled_source}
+        end
+        RUBY
+        # rubocop:enable Style/EvalWithLocation
+      end
+
+      @component.define_method(safe_method_name, @component.instance_method(@call_method_name))
+    end
+
+    def safe_method_name_call
+      return safe_method_name unless inline_call?
+
+      "maybe_escape_html(#{safe_method_name}) " \
+      "{ Kernel.warn(\"WARNING: The #{@component} component rendered HTML-unsafe output. " \
+      "The output will be automatically escaped, but you may want to investigate.\") } "
+    end
+
+    def requires_compiled_superclass?
+      inline_call? && !defined_on_self?
+    end
+
+    def inline_call?
+      @type == :inline_call
+    end
+
+    def inline?
+      @type == :inline
+    end
+
+    def default_format?
+      @this_format == ViewComponent::Base::VC_INTERNAL_DEFAULT_FORMAT
+    end
+
+    def format
+      @this_format
+    end
+
+    def safe_method_name
+      "_#{@call_method_name}_#{@component.name.underscore.gsub("/", "__")}"
+    end
+
+    def normalized_variant_name
+      @variant.to_s.gsub("-", "__").gsub(".", "___")
+    end
+
+    def defined_on_self?
+      @defined_on_self
+    end
+
+    private
+
+    def source
+      if @source_originally_nil
+        # Load file each time we look up #source in case the file has been modified
+        File.read(@path)
+      else
+        @source
+      end
+    end
+
+    def compiled_source
+      handler = ActionView::Template.handler_for_extension(@extension)
+      this_source = source
+      this_source.rstrip! if @component.strip_trailing_whitespace?
+
+      short_identifier = defined?(Rails.root) ? @path.sub("#{Rails.root}/", "") : @path
+      type = ActionView::Template::Types[@this_format]
+
+      if handler.method(:call).parameters.length > 1
+        handler.call(
+          DataWithSource.new(format: @this_format, identifier: @path, short_identifier: short_identifier, type: type),
+          this_source
+        )
+      # :nocov:
+      # TODO: Remove in v4
+      else
+        handler.call(DataNoSource.new(source: this_source, identifier: @path, type: type))
+      end
+      # :nocov:
+    end
+  end
+end

data/lib/view_component/test_helpers.rb

@@ -14,6 +14,10 @@ module ViewComponent
       def refute_component_rendered
         assert_no_selector("body")
       end
+
+      def assert_component_rendered
+        assert_selector("body")
+      end
     rescue LoadError
       # We don't have a test case for running an application without capybara installed.
       # It's probably fine to leave this without coverage.
@@ -59,6 +63,16 @@ module ViewComponent
       Nokogiri::HTML.fragment(@rendered_content)
     end
 
+    # `JSON.parse`-d component output.
+    #
+    # ```ruby
+    # render_inline(MyJsonComponent.new)
+    # assert_equal(rendered_json["hello"], "world")
+    # ```
+    def rendered_json
+      JSON.parse(rendered_content)
+    end
+
     # Render a preview inline. Internally sets `page` to be a `Capybara::Node::Simple`,
     # allowing for Capybara assertions to be used:
     #
@@ -141,7 +155,7 @@ module ViewComponent
     # end
     # ```
     #
-    # @param klass [ActionController::Base] The controller to be used.
+    # @param klass [Class<ActionController::Base>] The controller to be used.
     def with_controller_class(klass)
       old_controller = defined?(@vc_test_controller) && @vc_test_controller
 
@@ -151,6 +165,19 @@ module ViewComponent
       @vc_test_controller = old_controller
     end
 
+    # Set format of the current request
+    #
+    # ```ruby
+    # with_format(:json) do
+    #   render_inline(MyComponent.new)
+    # end
+    # ```
+    #
+    # @param format [Symbol] The format to be set for the provided block.
+    def with_format(format)
+      with_request_url("/", format: format) { yield }
+    end
+
     # Set the URL of the current request (such as when using request-dependent path helpers):
     #
     # ```ruby
@@ -178,7 +205,7 @@ module ViewComponent
     # @param full_path [String] The path to set for the current request.
     # @param host [String] The host to set for the current request.
     # @param method [String] The request method to set for the current request.
-    def with_request_url(full_path, host: nil, method: nil, format: :html)
+    def with_request_url(full_path, host: nil, method: nil, format: ViewComponent::Base::VC_INTERNAL_DEFAULT_FORMAT)
       old_request_host = vc_test_request.host
       old_request_method = vc_test_request.request_method
       old_request_path_info = vc_test_request.path_info
@@ -238,6 +265,8 @@ module ViewComponent
     #
     # @return [ActionDispatch::TestRequest]
     def vc_test_request
+      require "action_controller/test_case"
+
       @vc_test_request ||=
         begin
           out = ActionDispatch::TestRequest.create

data/lib/view_component/use_helpers.rb

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

data/lib/view_component/version.rb

@@ -3,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 3
-    MINOR = 10
-    PATCH = 0
+    MINOR = 23
+    PATCH = 2
     PRE = nil
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")