view_component 2.33.0 → 2.37.0

data/lib/view_component/collection.rb

@@ -5,6 +5,7 @@ require "action_view/renderer/collection_renderer" if Rails.version.to_f >= 6.1
 module ViewComponent
   class Collection
     attr_reader :component
+
     delegate :format, to: :component
 
     def render_in(view_context, &block)
@@ -16,7 +17,7 @@ module ViewComponent
         content = component.new(**component_options(item, iterator)).render_in(view_context, &block)
         iterator.iterate!
         content
-      end.join.html_safe
+      end.join.html_safe # rubocop:disable Rails/OutputSafety
     end
 
     private
@@ -31,7 +32,10 @@ module ViewComponent
       if object.respond_to?(:to_ary)
         object.to_ary
       else
-        raise ArgumentError.new("The value of the argument isn't a valid collection. Make sure it responds to to_ary: #{object.inspect}")
+        raise ArgumentError.new(
+          "The value of the first argument passed to `with_collection` isn't a valid collection. " \
+          "Make sure it responds to `to_ary`."
+        )
       end
     end
 

data/lib/view_component/compile_cache.rb

@@ -7,6 +7,7 @@ module ViewComponent
     mattr_accessor :cache, instance_reader: false, instance_accessor: false do
       Set.new
     end
+
     module_function
 
     def register(klass)

data/lib/view_component/compiler.rb

@@ -16,17 +16,22 @@ module ViewComponent
       subclass_instance_methods = component_class.instance_methods(false)
 
       if subclass_instance_methods.include?(:with_content) && raise_errors
-        raise ViewComponent::ComponentError.new("#{component_class} implements a reserved method, `with_content`.")
+        raise ViewComponent::ComponentError.new(
+          "#{component_class} implements a reserved method, `#with_content`.\n\n" \
+          "To fix this issue, change the name of the method."
+        )
       end
 
       if template_errors.present?
         raise ViewComponent::TemplateError.new(template_errors) if raise_errors
+
         return false
       end
 
       if subclass_instance_methods.include?(:before_render_check)
         ActiveSupport::Deprecation.warn(
-          "`before_render_check` will be removed in v3.0.0. Use `before_render` instead."
+          "`#before_render_check` will be removed in v3.0.0.\n\n" \
+          "To fix this issue, use `#before_render` instead."
         )
       end
 
@@ -39,7 +44,10 @@ module ViewComponent
         # Remove existing compiled template methods,
         # as Ruby warns when redefining a method.
         method_name = call_method_name(template[:variant])
-        component_class.send(:undef_method, method_name.to_sym) if component_class.instance_methods.include?(method_name.to_sym)
+
+        if component_class.instance_methods.include?(method_name.to_sym)
+          component_class.send(:undef_method, method_name.to_sym)
+        end
 
         component_class.class_eval <<-RUBY, template[:path], -1
           def #{method_name}
@@ -61,7 +69,9 @@ module ViewComponent
     attr_reader :component_class
 
     def define_render_template_for
-      component_class.send(:undef_method, :render_template_for) if component_class.instance_methods.include?(:render_template_for)
+      if component_class.instance_methods.include?(:render_template_for)
+        component_class.send(:undef_method, :render_template_for)
+      end
 
       variant_elsifs = variants.compact.uniq.map do |variant|
         "elsif variant.to_sym == :#{variant}\n    #{call_method_name(variant)}"
@@ -77,72 +87,90 @@ module ViewComponent
           end
         end
       RUBY
-
     end
 
     def template_errors
-      @_template_errors ||= begin
-        errors = []
+      @__vc_template_errors ||=
+        begin
+          errors = []
 
-        if (templates + inline_calls).empty?
-          errors << "Could not find a template file or inline render method for #{component_class}."
-        end
+          if (templates + inline_calls).empty?
+            errors << "Could not find a template file or inline render method for #{component_class}."
+          end
 
-        if templates.count { |template| template[:variant].nil? } > 1
-          errors << "More than one template found for #{component_class}. There can only be one default template file per component."
-        end
+          if templates.count { |template| template[:variant].nil? } > 1
+            errors <<
+              "More than one template found for #{component_class}. " \
+              "There can only be one default template file per component."
+          end
 
-        invalid_variants = templates
-          .group_by { |template| template[:variant] }
-          .map { |variant, grouped| variant if grouped.length > 1 }
-          .compact
-          .sort
+          invalid_variants =
+            templates.
+            group_by { |template| template[:variant] }.
+            map { |variant, grouped| variant if grouped.length > 1 }.
+            compact.
+            sort
+
+          unless invalid_variants.empty?
+            errors <<
+              "More than one template found for #{'variant'.pluralize(invalid_variants.count)} " \
+              "#{invalid_variants.map { |v| "'#{v}'" }.to_sentence} in #{component_class}. " \
+              "There can only be one template file per variant."
+          end
 
-        unless invalid_variants.empty?
-          errors << "More than one template found for #{'variant'.pluralize(invalid_variants.count)} #{invalid_variants.map { |v| "'#{v}'" }.to_sentence} in #{component_class}. There can only be one template file per variant."
-        end
+          if templates.find { |template| template[:variant].nil? } && inline_calls_defined_on_self.include?(:call)
+            errors <<
+              "Template file and inline render method found for #{component_class}. " \
+              "There can only be a template file or inline render method per component."
+          end
 
-        if templates.find { |template| template[:variant].nil? } && inline_calls_defined_on_self.include?(:call)
-          errors << "Template file and inline render method found for #{component_class}. There can only be a template file or inline render method per component."
-        end
+          duplicate_template_file_and_inline_variant_calls =
+            templates.pluck(:variant) & variants_from_inline_calls(inline_calls_defined_on_self)
 
-        duplicate_template_file_and_inline_variant_calls =
-          templates.pluck(:variant) & variants_from_inline_calls(inline_calls_defined_on_self)
+          unless duplicate_template_file_and_inline_variant_calls.empty?
+            count = duplicate_template_file_and_inline_variant_calls.count
 
-        unless duplicate_template_file_and_inline_variant_calls.empty?
-          count = duplicate_template_file_and_inline_variant_calls.count
+            errors <<
+              "Template #{'file'.pluralize(count)} and inline render #{'method'.pluralize(count)} " \
+              "found for #{'variant'.pluralize(count)} " \
+              "#{duplicate_template_file_and_inline_variant_calls.map { |v| "'#{v}'" }.to_sentence} " \
+              "in #{component_class}. " \
+              "There can only be a template file or inline render method per variant."
+          end
 
-          errors << "Template #{'file'.pluralize(count)} and inline render #{'method'.pluralize(count)} found for #{'variant'.pluralize(count)} #{duplicate_template_file_and_inline_variant_calls.map { |v| "'#{v}'" }.to_sentence} in #{component_class}. There can only be a template file or inline render method per variant."
+          errors
         end
-
-        errors
-      end
     end
 
     def templates
-      @templates ||= begin
-        extensions = ActionView::Template.template_handler_extensions
-
-        component_class._sidecar_files(extensions).each_with_object([]) do |path, memo|
-          pieces = File.basename(path).split(".")
-          memo << {
-            path: path,
-            variant: pieces.second.split("+").second&.to_sym,
-            handler: pieces.last
-          }
+      @templates ||=
+        begin
+          extensions = ActionView::Template.template_handler_extensions
+
+          component_class._sidecar_files(extensions).each_with_object([]) do |path, memo|
+            pieces = File.basename(path).split(".")
+            memo << {
+              path: path,
+              variant: pieces.second.split("+").second&.to_sym,
+              handler: pieces.last
+            }
+          end
         end
-      end
     end
 
     def inline_calls
-      @inline_calls ||= begin
-        # Fetch only ViewComponent ancestor classes to limit the scope of
-        # finding inline calls
-        view_component_ancestors =
-          component_class.ancestors.take_while { |ancestor| ancestor != ViewComponent::Base } - component_class.included_modules
-
-        view_component_ancestors.flat_map { |ancestor| ancestor.instance_methods(false).grep(/^call/) }.uniq
-      end
+      @inline_calls ||=
+        begin
+          # Fetch only ViewComponent ancestor classes to limit the scope of
+          # finding inline calls
+          view_component_ancestors =
+            (
+              component_class.ancestors.take_while { |ancestor| ancestor != ViewComponent::Base } -
+              component_class.included_modules
+            )
+
+          view_component_ancestors.flat_map { |ancestor| ancestor.instance_methods(false).grep(/^call/) }.uniq
+        end
     end
 
     def inline_calls_defined_on_self
@@ -150,7 +178,7 @@ module ViewComponent
     end
 
     def variants
-      @_variants = (
+      @__vc_variants = (
         templates.map { |template| template[:variant] } + variants_from_inline_calls(inline_calls)
       ).compact.uniq
     end
@@ -168,7 +196,13 @@ module ViewComponent
       if handler.method(:call).parameters.length > 1
         handler.call(component_class, template)
       else
-        handler.call(OpenStruct.new(source: template, identifier: component_class.identifier, type: component_class.type))
+        handler.call(
+          OpenStruct.new(
+            source: template,
+            identifier: component_class.identifier,
+            type: component_class.type
+          )
+        )
       end
     end
 

data/lib/view_component/content_areas.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+require "view_component/slot"
+
+# DEPRECATED - ContentAreas is deprecated and will be removed in v3.0.0
+module ViewComponent
+  module ContentAreas
+    extend ActiveSupport::Concern
+
+    # Assign the provided content to the content area accessor
+    #
+    # @private
+    def with(area, content = nil, &block)
+      unless content_areas.include?(area)
+        raise ArgumentError.new(
+          "Unknown content_area '#{area}' for #{self} - expected one of '#{content_areas}'.\n\n" \
+          "To fix this issue, add `with_content_area :#{area}` to #{self} or reference " \
+          "a valid content area."
+        )
+      end
+
+      if block_given?
+        content = view_context.capture(&block)
+      end
+
+      instance_variable_set("@#{area}".to_sym, content)
+      nil
+    end
+
+    class_methods do
+      def with_content_areas(*areas)
+        ActiveSupport::Deprecation.warn(
+          "`with_content_areas` is deprecated and will be removed in ViewComponent v3.0.0.\n\n" \
+          "Use slots (https://viewcomponent.org/guide/slots.html) instead."
+        )
+
+        if areas.include?(:content)
+          raise ArgumentError.new(
+            "#{self} defines a content area called :content, which is a reserved name. \n\n" \
+            "To fix this issue, use another name, such as `:body`."
+          )
+        end
+
+        areas.each do |area|
+          define_method area.to_sym do
+            content unless content_evaluated? # ensure content is loaded so content_areas will be defined
+            instance_variable_get(:"@#{area}") if instance_variable_defined?(:"@#{area}")
+          end
+        end
+
+        self.content_areas = areas
+      end
+    end
+  end
+end

data/lib/view_component/engine.rb

@@ -13,6 +13,7 @@ module ViewComponent
 
       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.instrumentation_enabled = false if options.instrumentation_enabled.nil?
       options.preview_route ||= ViewComponent::Base.preview_route
       options.preview_controller ||= ViewComponent::Base.preview_controller
 
@@ -30,7 +31,17 @@ module ViewComponent
       end
 
       ActiveSupport.on_load(:view_component) do
-        options.each { |k, v| send("#{k}=", v) }
+        options.each { |k, v| send("#{k}=", v) if respond_to?("#{k}=") }
+      end
+    end
+
+    initializer "view_component.enable_instrumentation" do |app|
+      ActiveSupport.on_load(:view_component) do
+        if app.config.view_component.instrumentation_enabled.present?
+          # :nocov:
+          ViewComponent::Base.prepend(ViewComponent::Instrumentation)
+          # :nocov:
+        end
       end
     end
 
@@ -86,6 +97,12 @@ module ViewComponent
       end
     end
 
+    initializer "static assets" do |app|
+      if app.config.view_component.show_previews
+        app.middleware.insert_before(::ActionDispatch::Static, ::ActionDispatch::Static, "#{root}/app/assets/vendor")
+      end
+    end
+
     config.after_initialize do |app|
       options = app.config.view_component
 
@@ -93,8 +110,19 @@ module ViewComponent
         app.routes.prepend do
           preview_controller = options.preview_controller.sub(/Controller$/, "").underscore
 
-          get options.preview_route, to: "#{preview_controller}#index", as: :preview_view_components, internal: true
-          get "#{options.preview_route}/*path", to: "#{preview_controller}#previews", as: :preview_view_component, internal: true
+          get(
+            options.preview_route,
+            to: "#{preview_controller}#index",
+            as: :preview_view_components,
+            internal: true
+          )
+
+          get(
+            "#{options.preview_route}/*path",
+            to: "#{preview_controller}#previews",
+            as: :preview_view_component,
+            internal: true
+          )
         end
       end
 

data/lib/view_component/instrumentation.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+require "active_support/notifications"
+
+module ViewComponent # :nodoc:
+  module Instrumentation
+    def self.included(mod)
+      mod.prepend(self)
+    end
+
+    def render_in(view_context, &block)
+      ActiveSupport::Notifications.instrument(
+        "!render.view_component",
+        name: self.class.name,
+        identifier: self.class.identifier
+      ) do
+        super(view_context, &block)
+      end
+    end
+  end
+end

data/lib/view_component/preview.rb

@@ -71,19 +71,30 @@ module ViewComponent # :nodoc:
 
       # 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
-        end
+        preview_path =
+          Array(preview_paths).detect do |preview_path|
+            Dir["#{preview_path}/#{preview_name}_preview/#{example}.html.*"].first
+          end
 
         if preview_path.nil?
-          raise PreviewTemplateError, "preview template for example #{example} does not exist"
+          raise(
+            PreviewTemplateError,
+            "A preview template for example #{example} does not exist.\n\n" \
+            "To fix this issue, create a template for the example."
+          )
         end
 
         path = Dir["#{preview_path}/#{preview_name}_preview/#{example}.html.*"].first
-        Pathname.new(path)
-                .relative_path_from(Pathname.new(preview_path))
-                .to_s
-                .sub(/\..*$/, "")
+        Pathname.new(path).
+          relative_path_from(Pathname.new(preview_path)).
+          to_s.
+          sub(/\..*$/, "")
+      end
+
+      # Returns the method body for the example from the preview file.
+      def preview_source(example)
+        source = self.instance_method(example.to_sym).source.split("\n")
+        source[1...(source.size - 1)].join("\n")
       end
 
       private

data/lib/view_component/previewable.rb

@@ -2,51 +2,49 @@
 
 require "active_support/concern"
 
-module ViewComponent # :nodoc:
+module ViewComponent
   module Previewable
     extend ActiveSupport::Concern
 
     included do
-      # Set a custom default preview layout through app configuration:
+      # Enable or disable component previews:
       #
-      #     config.view_component.default_preview_layout = "component_preview"
+      #     config.view_component.show_previews = true
       #
-      # This affects preview index pages as well as individual component previews
+      # Defaults to `true` in development.
+      #
+      mattr_accessor :show_previews, instance_writer: 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 through app configuration:
+      # Set the location of component previews:
       #
       #     config.view_component.preview_paths << "#{Rails.root}/lib/component_previews"
       #
       mattr_accessor :preview_paths, instance_writer: false
 
-      # TODO: deprecated, remove in v3.0.0
+      # @deprecated Use `preview_paths` instead. Will be removed in v3.0.0.
       mattr_accessor :preview_path, instance_writer: false
 
-      # Enable or disable component previews through app configuration:
-      #
-      #     config.view_component.show_previews = true
-      #
-      # Defaults to +true+ for development environment
-      #
-      mattr_accessor :show_previews, instance_writer: false
-
-      # Set the entry route for component previews through app configuration:
+      # Set the entry route for component previews:
       #
       #     config.view_component.preview_route = "/previews"
       #
-      # Defaults to +/rails/view_components+ when `show_previews' is enabled
+      # 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 to be used for previewing components through app configuration:
+      # Set the controller used for previewing components:
       #
       #     config.view_component.preview_controller = "MyPreviewController"
       #
-      # Defaults to the provided +ViewComponentsController+
+      # Defaults to `ViewComponentsController`.
       #
       mattr_accessor :preview_controller, instance_writer: false do
         "ViewComponentsController"