view_component 2.49.1 → 3.23.2

data/lib/view_component/errors.rb

@@ -0,0 +1,240 @@
+module ViewComponent
+  class BaseError < StandardError
+    def initialize
+      super(self.class::MESSAGE)
+    end
+  end
+
+  class DuplicateSlotContentError < StandardError
+    MESSAGE =
+      "It looks like a block was provided after calling `with_content` on COMPONENT, " \
+      "which means that ViewComponent doesn't know which content to use.\n\n" \
+      "To fix this issue, use either `with_content` or a block."
+
+    def initialize(klass_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s))
+    end
+  end
+
+  class TemplateError < StandardError
+    def initialize(errors, templates = nil)
+      message = errors.join("\n")
+
+      super(message)
+    end
+  end
+
+  class MultipleInlineTemplatesError < BaseError
+    MESSAGE = "Inline templates can only be defined once per-component."
+  end
+
+  class MissingPreviewTemplateError < StandardError
+    MESSAGE =
+      "A preview template for example EXAMPLE doesn't exist.\n\n" \
+      "To fix this issue, create a template for the example."
+
+    def initialize(example)
+      super(MESSAGE.gsub("EXAMPLE", example))
+    end
+  end
+
+  class DuplicateContentError < StandardError
+    MESSAGE =
+      "It looks like a block was provided after calling `with_content` on COMPONENT, " \
+      "which means that ViewComponent doesn't know which content to use.\n\n" \
+      "To fix this issue, use either `with_content` or a block."
+
+    def initialize(klass_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s))
+    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`, " \
+      "which is required 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 ReservedParameterError < StandardError
+    MESSAGE =
+      "COMPONENT initializer can't accept the parameter `PARAMETER`, as it will override a " \
+      "public ViewComponent method. To fix this issue, rename the parameter."
+
+    def initialize(klass_name, parameter)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("PARAMETER", parameter.to_s))
+    end
+  end
+
+  class InvalidCollectionArgumentError < BaseError
+    MESSAGE =
+      "The value of the first argument passed to `with_collection` isn't a valid collection. " \
+      "Make sure it responds to `to_ary`."
+  end
+
+  class ContentSlotNameError < StandardError
+    MESSAGE =
+      "COMPONENT declares a slot named content, which is a reserved word in ViewComponent.\n\n" \
+      "Content passed to a ViewComponent as a block is captured and assigned to the `content` accessor without having to create an explicit slot.\n\n" \
+      "To fix this issue, either use the `content` accessor directly or choose a different slot name."
+
+    def initialize(klass_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s))
+    end
+  end
+
+  class InvalidSlotDefinitionError < BaseError
+    MESSAGE =
+      "Invalid slot definition. Please pass a class, " \
+      "string, or callable (that is proc, lambda, etc)"
+  end
+
+  class InvalidSlotNameError < StandardError
+  end
+
+  class SlotPredicateNameError < InvalidSlotNameError
+    MESSAGE =
+      "COMPONENT declares a slot named SLOT_NAME, which ends with a question mark.\n\n" \
+      "This isn't allowed because the ViewComponent framework already provides predicate " \
+      "methods ending in `?`.\n\n" \
+      "To fix this issue, choose a different name."
+
+    def initialize(klass_name, slot_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("SLOT_NAME", slot_name.to_s))
+    end
+  end
+
+  class RedefinedSlotError < StandardError
+    MESSAGE =
+      "COMPONENT declares the SLOT_NAME slot multiple times.\n\n" \
+      "To fix this issue, choose a different slot name."
+
+    def initialize(klass_name, slot_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("SLOT_NAME", slot_name.to_s))
+    end
+  end
+
+  class ReservedSingularSlotNameError < InvalidSlotNameError
+    MESSAGE =
+      "COMPONENT declares a slot named SLOT_NAME, which is a reserved word in the ViewComponent framework.\n\n" \
+      "To fix this issue, choose a different name."
+
+    def initialize(klass_name, slot_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("SLOT_NAME", slot_name.to_s))
+    end
+  end
+
+  class ReservedPluralSlotNameError < InvalidSlotNameError
+    MESSAGE =
+      "COMPONENT declares a slot named SLOT_NAME, which is a reserved word in the ViewComponent framework.\n\n" \
+      "To fix this issue, choose a different name."
+
+    def initialize(klass_name, slot_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("SLOT_NAME", slot_name.to_s))
+    end
+  end
+
+  class UncountableSlotNameError < InvalidSlotNameError
+    MESSAGE =
+      "COMPONENT declares a slot named SLOT_NAME, which is an uncountable word\n\n" \
+      "To fix this issue, choose a different name."
+
+    def initialize(klass_name, slot_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("SLOT_NAME", slot_name.to_s))
+    end
+  end
+
+  class ContentAlreadySetForPolymorphicSlotError < StandardError
+    MESSAGE = "Content for slot SLOT_NAME has already been provided."
+
+    def initialize(slot_name)
+      super(MESSAGE.gsub("SLOT_NAME", slot_name.to_s))
+    end
+  end
+
+  class NilWithContentError < BaseError
+    MESSAGE =
+      "No content provided to `#with_content` for #{self}.\n\n" \
+      "To fix this issue, pass a value."
+  end
+
+  class TranslateCalledBeforeRenderError < BaseError
+    MESSAGE =
+      "`#translate` can't be used before rendering as it depends " \
+      "on the view context that only exists once a ViewComponent is passed to " \
+      "the Rails render pipeline.\n\n" \
+      "It's sometimes possible to fix this issue by moving code dependent on " \
+      "`#translate` to a [`#before_render` method](https://viewcomponent.org/api.html#before_render--void)."
+  end
+
+  class HelpersCalledBeforeRenderError < BaseError
+    MESSAGE =
+      "`#helpers` can't be used before rendering as it depends " \
+      "on the view context that only exists once a ViewComponent is passed to " \
+      "the Rails render pipeline.\n\n" \
+      "It's sometimes possible to fix this issue by moving code dependent on " \
+      "`#helpers` to a [`#before_render` method](https://viewcomponent.org/api.html#before_render--void)."
+  end
+
+  class ControllerCalledBeforeRenderError < BaseError
+    MESSAGE =
+      "`#controller` can't be used before rendering, as it depends " \
+      "on the view context that only exists once a ViewComponent is passed to " \
+      "the Rails render pipeline.\n\n" \
+      "It's sometimes possible to fix this issue by moving code dependent on " \
+      "`#controller` to a [`#before_render` method](https://viewcomponent.org/api.html#before_render--void)."
+  end
+
+  # :nocov:
+  class NoMatchingTemplatesForPreviewError < StandardError
+    MESSAGE = "Found 0 matches for templates for TEMPLATE_IDENTIFIER."
+
+    def initialize(template_identifier)
+      super(MESSAGE.gsub("TEMPLATE_IDENTIFIER", template_identifier))
+    end
+  end
+
+  class MultipleMatchingTemplatesForPreviewError < StandardError
+    MESSAGE = "Found multiple templates for TEMPLATE_IDENTIFIER."
+
+    def initialize(template_identifier)
+      super(MESSAGE.gsub("TEMPLATE_IDENTIFIER", template_identifier))
+    end
+  end
+  # :nocov:
+
+  class SystemTestControllerOnlyAllowedInTestError < BaseError
+    MESSAGE = "ViewComponent SystemTest controller must only be called in a test environment for security reasons."
+  end
+
+  class SystemTestControllerNefariousPathError < BaseError
+    MESSAGE = "ViewComponent SystemTest controller attempted to load a file outside of the expected directory."
+  end
+
+  class AlreadyDefinedPolymorphicSlotSetterError < StandardError
+    MESSAGE =
+      "A method called 'SETTER_METHOD_NAME' already exists and would be overwritten by the 'SETTER_NAME' polymorphic " \
+      "slot setter.\n\nPlease choose a different setter name."
+
+    def initialize(setter_method_name, setter_name)
+      super(MESSAGE.gsub("SETTER_METHOD_NAME", setter_method_name.to_s).gsub("SETTER_NAME", setter_name.to_s))
+    end
+  end
+end

data/lib/view_component/inline_template.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module ViewComponent # :nodoc:
+  module InlineTemplate
+    extend ActiveSupport::Concern
+    Template = Struct.new(:source, :language, :path, :lineno)
+
+    class_methods do
+      def method_missing(method, *args)
+        return super if !method.end_with?("_template")
+
+        if defined?(@__vc_inline_template_defined) && @__vc_inline_template_defined
+          raise MultipleInlineTemplatesError
+        end
+
+        if args.size != 1
+          raise ArgumentError, "wrong number of arguments (given #{args.size}, expected 1)"
+        end
+
+        ext = method.to_s.gsub("_template", "")
+        template = args.first
+
+        @__vc_inline_template_language = ext
+
+        caller = caller_locations(1..1)[0]
+        @__vc_inline_template = Template.new(
+          template,
+          ext,
+          caller.absolute_path || caller.path,
+          caller.lineno
+        )
+
+        @__vc_inline_template_defined = true
+      end
+      ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
+
+      def respond_to_missing?(method, include_all = false)
+        method.end_with?("_template") || super
+      end
+
+      def inline_template
+        @__vc_inline_template if defined?(@__vc_inline_template)
+      end
+
+      def inline_template_language
+        @__vc_inline_template_language if defined?(@__vc_inline_template_language)
+      end
+
+      def inherited(subclass)
+        super
+        subclass.instance_variable_set(:@__vc_inline_template_language, inline_template_language)
+      end
+    end
+  end
+end

data/lib/view_component/instrumentation.rb

@@ -10,14 +10,22 @@ module ViewComponent # :nodoc:
 
     def render_in(view_context, &block)
       ActiveSupport::Notifications.instrument(
-        "!render.view_component",
+        notification_name,
         {
           name: self.class.name,
           identifier: self.class.identifier
         }
       ) do
-        super(view_context, &block)
+        super
       end
     end
+
+    private
+
+    def notification_name
+      return "!render.view_component" if ViewComponent::Base.config.use_deprecated_instrumentation_name
+
+      "render.view_component"
+    end
   end
 end

data/lib/view_component/preview.rb

@@ -4,6 +4,11 @@ require "active_support/descendants_tracker"
 
 module ViewComponent # :nodoc:
   class Preview
+    if defined?(Rails.application.routes.url_helpers)
+      # Workaround from https://stackoverflow.com/questions/20853526/make-yard-ignore-certain-class-extensions to appease YARD
+      send(:include, Rails.application.routes.url_helpers)
+    end
+
     include ActionView::Helpers::TagHelper
     include ActionView::Helpers::AssetTagHelper
     extend ActiveSupport::DescendantsTracker
@@ -14,7 +19,7 @@ module ViewComponent # :nodoc:
         block: block,
         component: component,
         locals: {},
-        template: "view_components/preview",
+        template: "view_components/preview"
       }
     end
 
@@ -30,7 +35,8 @@ module ViewComponent # :nodoc:
     class << self
       # Returns all component preview classes.
       def all
-        load_previews if descendants.empty?
+        load_previews
+
         descendants
       end
 
@@ -65,47 +71,43 @@ 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)
         preview_path =
-          Array(preview_paths).detect do |preview_path|
-            Dir["#{preview_path}/#{preview_name}_preview/#{example}.html.*"].first
+          Array(preview_paths).detect do |path|
+            Dir["#{path}/#{preview_name}_preview/#{example}.html.*"].first
           end
 
-        if preview_path.nil?
-          raise(
-            PreviewTemplateError,
-            "A preview template for example #{example} doesn't exist.\n\n" \
-            "To fix this issue, create a template for the example."
-          )
-        end
+        raise MissingPreviewTemplateError.new(example) if preview_path.nil?
 
         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 }
+          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/rails/tasks/view_component.rake

@@ -3,9 +3,18 @@
 task stats: "view_component:statsetup"
 
 namespace :view_component do
-  task statsetup: :environment do
+  task :statsetup do
+    # :nocov:
     require "rails/code_statistics"
 
-    ::STATS_DIRECTORIES << ["ViewComponents", ViewComponent::Base.view_component_path]
+    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/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.rb

@@ -1,7 +1,125 @@
 # frozen_string_literal: true
 
+require "view_component/with_content_helper"
+
 module ViewComponent
   class Slot
-    attr_accessor :content
+    include ViewComponent::WithContentHelper
+
+    attr_writer :__vc_component_instance, :__vc_content_block, :__vc_content
+
+    def initialize(parent)
+      @parent = parent
+    end
+
+    def content?
+      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?
+    end
+
+    def with_content(args)
+      if __vc_component_instance?
+        @__vc_component_instance.with_content(args)
+      else
+        super
+      end
+    end
+
+    # Used to render the slot content in the template
+    #
+    # There's currently 3 different values that may be set, that we can render.
+    #
+    # If the slot renderable is a component, the string class name of a
+    # component, or a function that returns a component, we render that
+    # component instance, returning the string.
+    #
+    # If the slot renderable is a function and returns a string, it's
+    # set as `@__vc_content` and is returned directly.
+    #
+    # If there is no slot renderable, we evaluate the block passed to
+    # the slot and return it.
+    def to_s
+      return @content if defined?(@content)
+
+      view_context = @parent.send(:view_context)
+
+      if defined?(@__vc_content_block) && defined?(@__vc_content_set_by_with_content)
+        raise DuplicateSlotContentError.new(self.class.name)
+      end
+
+      @content =
+        if __vc_component_instance?
+          @__vc_component_instance.__vc_original_view_context = @parent.__vc_original_view_context
+
+          if defined?(@__vc_content_block)
+            # render_in is faster than `parent.render`
+            @__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
+        elsif defined?(@__vc_content)
+          @__vc_content
+        elsif defined?(@__vc_content_block)
+          view_context.capture(&@__vc_content_block)
+        elsif defined?(@__vc_content_set_by_with_content)
+          @__vc_content_set_by_with_content
+        end
+
+      @content = @content.to_s
+    end
+
+    # Allow access to public component methods via the wrapper
+    #
+    # for example
+    #
+    # calling `header.name` (where `header` is a slot) will call `name`
+    # on the `HeaderComponent` instance.
+    #
+    # Where the component may look like:
+    #
+    # class MyComponent < ViewComponent::Base
+    #   has_one :header, HeaderComponent
+    #
+    #   class HeaderComponent < ViewComponent::Base
+    #     def name
+    #       @name
+    #     end
+    #   end
+    # end
+    #
+    def method_missing(symbol, *args, &block)
+      @__vc_component_instance.public_send(symbol, *args, &block)
+    end
+    ruby2_keywords(:method_missing) if respond_to?(:ruby2_keywords, true)
+
+    def html_safe?
+      # :nocov:
+      to_s.html_safe?
+      # :nocov:
+    end
+
+    def respond_to_missing?(symbol, include_all = false)
+      __vc_component_instance? && @__vc_component_instance.respond_to?(symbol, include_all)
+    end
+
+    private
+
+    def __vc_component_instance?
+      defined?(@__vc_component_instance)
+    end
   end
 end