view_component 2.34.0 → 2.35.0

data/lib/view_component/compiler.rb

@@ -21,12 +21,13 @@ module ViewComponent
 
       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. Use `#before_render` instead."
         )
       end
 
@@ -77,72 +78,75 @@ 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."
+          end
 
-        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 +154,7 @@ module ViewComponent
     end
 
     def variants
-      @_variants = (
+      @__vc_variants = (
         templates.map { |template| template[:variant] } + variants_from_inline_calls(inline_calls)
       ).compact.uniq
     end

data/lib/view_component/content_areas.rb

@@ -0,0 +1,50 @@
+# 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}' - expected one of '#{content_areas}'"
+      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" \
+          "Use slots (https://viewcomponent.org/guide/slots.html) instead."
+        )
+
+        if areas.include?(:content)
+          raise ArgumentError.new ":content is a reserved content area name. Please 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

@@ -97,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
 

data/lib/view_component/preview.rb

@@ -71,19 +71,26 @@ 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"
         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"

data/lib/view_component/slot_v2.rb

@@ -6,7 +6,7 @@ module ViewComponent
   class SlotV2
     include ViewComponent::WithContentHelper
 
-    attr_writer :_component_instance, :_content_block, :_content
+    attr_writer :__vc_component_instance, :__vc_content_block, :__vc_content
 
     def initialize(parent)
       @parent = parent
@@ -21,7 +21,7 @@ module ViewComponent
     # component instance, returning the string.
     #
     # If the slot renderable is a function and returns a string, it is
-    # set as `@_content` and is returned directly.
+    # 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.
@@ -30,32 +30,33 @@ module ViewComponent
 
       view_context = @parent.send(:view_context)
 
-      raise ArgumentError.new("Block provided after calling `with_content`. Use one or the other.") if defined?(@_content_block) && defined?(@_content_set_by_with_content)
+      raise ArgumentError.new("Block provided after calling `with_content`. Use one or the other.") if defined?(@__vc_content_block) && defined?(@__vc_content_set_by_with_content)
 
-      @content = if defined?(@_component_instance)
-        if defined?(@_content_set_by_with_content)
-          @_component_instance.with_content(@_content_set_by_with_content)
+      @content =
+        if defined?(@__vc_component_instance)
+          if defined?(@__vc_content_set_by_with_content)
+            @__vc_component_instance.with_content(@__vc_content_set_by_with_content)
 
-          view_context.capture do
-            @_component_instance.render_in(view_context)
+            view_context.capture do
+              @__vc_component_instance.render_in(view_context)
+            end
+          elsif defined?(@__vc_content_block)
+            view_context.capture do
+              # render_in is faster than `parent.render`
+              @__vc_component_instance.render_in(view_context, &@__vc_content_block)
+            end
+          else
+            view_context.capture do
+              @__vc_component_instance.render_in(view_context)
+            end
           end
-        elsif defined?(@_content_block)
-          view_context.capture do
-            # render_in is faster than `parent.render`
-            @_component_instance.render_in(view_context, &@_content_block)
-          end
-        else
-          view_context.capture do
-            @_component_instance.render_in(view_context)
-          end
-        end
-      elsif defined?(@_content)
-        @_content
-      elsif defined?(@_content_block)
-        view_context.capture(&@_content_block)
-      elsif defined?(@_content_set_by_with_content)
-        @_content_set_by_with_content
-      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
     end
@@ -80,7 +81,7 @@ module ViewComponent
     # end
     #
     def method_missing(symbol, *args, &block)
-      @_component_instance.public_send(symbol, *args, &block)
+      @__vc_component_instance.public_send(symbol, *args, &block)
     end
 
     def html_safe?
@@ -88,7 +89,7 @@ module ViewComponent
     end
 
     def respond_to_missing?(symbol, include_all = false)
-      defined?(@_component_instance) && @_component_instance.respond_to?(symbol, include_all)
+      defined?(@__vc_component_instance) && @__vc_component_instance.respond_to?(symbol, include_all)
     end
   end
 end

data/lib/view_component/slotable.rb

@@ -123,6 +123,7 @@ module ViewComponent
       slot_instance = args.present? ? slot_class.new(**args) : slot_class.new
 
       # Capture block and assign to slot_instance#content
+      # rubocop:disable Rails/OutputSafety
       slot_instance.content = view_context.capture(&block).to_s.strip.html_safe if block_given?
 
       if slot[:collection]
@@ -135,7 +136,7 @@ module ViewComponent
         # Append Slot instance to collection accessor Array
         instance_variable_get(slot[:instance_variable_name]) << slot_instance
       else
-         # Assign the Slot instance to the slot accessor
+        # Assign the Slot instance to the slot accessor
         instance_variable_set(slot[:instance_variable_name], slot_instance)
       end
 

data/lib/view_component/slotable_v2.rb

@@ -190,10 +190,10 @@ module ViewComponent
       content unless content_evaluated? # ensure content is loaded so slots will be defined
 
       slot = self.class.registered_slots[slot_name]
-      @_set_slots ||= {}
+      @__vc_set_slots ||= {}
 
-      if @_set_slots[slot_name]
-        return @_set_slots[slot_name]
+      if @__vc_set_slots[slot_name]
+        return @__vc_set_slots[slot_name]
       end
 
       if slot[:collection]
@@ -217,42 +217,43 @@ module ViewComponent
       # 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._content_block = block if block_given?
+      slot.__vc_content_block = block if block_given?
 
       # If class
       if slot_definition[:renderable]
-        slot._component_instance = slot_definition[:renderable].new(*args, **kwargs)
+        slot.__vc_component_instance = slot_definition[:renderable].new(*args, **kwargs)
       # If class name as a string
       elsif slot_definition[:renderable_class_name]
-        slot._component_instance = self.class.const_get(slot_definition[:renderable_class_name]).new(*args, **kwargs)
+        slot.__vc_component_instance = self.class.const_get(slot_definition[:renderable_class_name]).new(*args, **kwargs)
       # If passed a lambda
       elsif slot_definition[:renderable_function]
         # Use `bind(self)` to ensure lambda is executed in the context of the
         # current component. This is necessary to allow the lambda to access helper
         # methods like `content_tag` as well as parent component state.
-        renderable_value = if block_given?
-          slot_definition[:renderable_function].bind(self).call(*args, **kwargs) do |*args, **kwargs|
-            view_context.capture(*args, **kwargs, &block)
+        renderable_value =
+          if block_given?
+            slot_definition[:renderable_function].bind(self).call(*args, **kwargs) do |*args, **kwargs|
+              view_context.capture(*args, **kwargs, &block)
+            end
+          else
+            slot_definition[:renderable_function].bind(self).call(*args, **kwargs)
           end
-        else
-          slot_definition[:renderable_function].bind(self).call(*args, **kwargs)
-        end
 
         # Function calls can return components, so if it's a component handle it specially
         if renderable_value.respond_to?(:render_in)
-          slot._component_instance = renderable_value
+          slot.__vc_component_instance = renderable_value
         else
-          slot._content = renderable_value
+          slot.__vc_content = renderable_value
         end
       end
 
-      @_set_slots ||= {}
+      @__vc_set_slots ||= {}
 
       if slot_definition[:collection]
-        @_set_slots[slot_name] ||= []
-        @_set_slots[slot_name].push(slot)
+        @__vc_set_slots[slot_name] ||= []
+        @__vc_set_slots[slot_name].push(slot)
       else
-        @_set_slots[slot_name] = slot
+        @__vc_set_slots[slot_name] = slot
       end
 
       slot