view_component 2.49.1 → 2.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ef9372866a072103dd38b8da27bfcf57ad66012524b6a80f6caf311a97533435
-  data.tar.gz: 654c9561c09c8cae7ca8720d126060e8196d38b0cd832d6a5a6e1f7e8c8ad133
+  metadata.gz: 1eb8c14aae22e2977db7cde77cd64f9ff1d69f14c0f2c95b6b2ebf0fabf67f5a
+  data.tar.gz: fe2c729ae013bf1dd2effb17143acfef756e915ea773dcb7eef84fd329c7e002
 SHA512:
-  metadata.gz: fbd9bf43a06132fa0d26fba5155382be904bba9aaf181c9bb0f715a3caf103f5ae7bff74640e62c31e3ea8600a61f5405e364553b5f56f3cbc5af7a22a77f5f8
-  data.tar.gz: 946639d557fd6dd76889c6a645187fc1235bd7e76817944429f306be1d7798ac9fe9b8005301f3ea106c564d6502d3e1bc21fc1ea5b9902784d99296979c8d93
+  metadata.gz: 0e72fac02dd38cd39cfa7fe45bc57617a8088d2016add0c769df9075393dc8fde66ea44c96d466019354585da3754b1db2099e9207a46418b011e6ef8765b816
+  data.tar.gz: 6ec82473f583cd484e9ee4042683d7d605131279ef855a199f1a89292967dd971c6ed8a43f8ad7fc9d519bae02fb4f2e5cf8d14f4876ffa1b524ad41ce25ea20

data/app/helpers/preview_helper.rb

@@ -27,8 +27,8 @@ module PreviewHelper
       end.flatten
 
       # Search for templates the contain `html`.
-      matching_templates = all_template_paths.find_all do |template|
-        template =~ /#{template_identifier}*.(html)/
+      matching_templates = all_template_paths.find_all do |path|
+        path =~ /#{template_identifier}*.(html)/
       end
 
       # In-case of a conflict due to multiple template files with

data/docs/CHANGELOG.md

@@ -7,9 +7,94 @@ title: Changelog
 
 ## main
 
+## 2.52.0
+
+* Add ADR for separate slot getter/setter API.
+
+    *Blake Williams*
+
+* Add the option to use a "global" output buffer so `form_for` and friends can be used with view components.
+
+    *Cameron Dutro*, *Blake Williams*
+
+* Fix fragment caching in partials when global output buffer is enabled.
+* Fix template inheritance when eager loading is disabled.
+
+    *Cameron Dutro*
+
+## 2.51.0
+
+* Update the docs only when releasing a new version.
+
+    *Hans Lemuet*
+
+* Alphabetize companies using ViewComponent and add Brightline to the list.
+
+    *Jack Schuss*
+
+* Add CMYK value for ViewComponent Red color on logo page.
+
+    *Dylan Smith*
+
+* Improve performance by moving template compilation from `#render_in` to `#render_template_for`.
+
+    *Cameron Dutro*
+
+## 2.50.0
+
+* Add tests for `layout` usage when rendering via controller.
+
+    *Felipe Sateler*
+
+* Support returning Arrays from i18n files, and support marking them as HTML-safe translations.
+
+    *foca*
+
+* Add Cometeer and Framework to users list.
+
+    *Elia Schito*
+
+* Update Microsoft Vale styles.
+
+    *Simon Fish*
+
+* Fix example in testing guide for how to setup default Rails tests.
+
+    *Steven Hansen*
+
+* Update benchmark script to render multiple components/partials instead of a single instance per-run.
+
+    *Blake Williams*
+
+* Add predicate methods `#{slot_name}?` to slots.
+
+    *Hans Lemuet*
+
+* Use a dedicated deprecation instance, silence it while testing.
+
+    *Max Beizer, Hans Lemuet, Elia Schito*
+
+* Fix Ruby warnings.
+
+    *Hans Lemuet*
+
+* Place all generator options under `config.generate` namespace.
+
+    *Simon Fish*
+
+* Allow preview generator to use provided component attributes.
+* Add config option `config.view_component.generate.preview` to enable project-wide preview generation.
+* Ensure all generated `.rb` files include `# frozen_string_literal: true` statement.
+
+    *Bob Maerten*
+
+* Add Shogun to users list.
+
+    *Bernie Chiu*
+
 ## 2.49.1
 
-* Patch XSS vulnerability in `Translatable` module caused by improperly escaped interpolation arguments.
+* Patch XSS vulnerability in `ViewComponent::Translatable` module caused by improperly escaped interpolation arguments.
 
     *Cameron Dutro*
 
@@ -619,6 +704,12 @@ title: Changelog
 
     *Joel Hawksley*
 
+## 2.31.2
+
+* Patch XSS vulnerability in `ViewComponent::Translatable` module caused by improperly escaped interpolation arguments.
+
+    *Cameron Dutro*
+
 ## 2.31.1
 
 * Fix `DEPRECATION WARNING: before_render_check` when compiling `ViewComponent::Base`
@@ -663,12 +754,6 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
     *Joel Hawksley*
 
-## 2.29.1
-
-* Patch XSS vulnerability in `ViewComponent::Translatable` module caused by improperly escaped interpolation arguments.
-
-    *Cameron Dutro*
-
 ## 2.29.0
 
 * Allow Slot lambdas to share data from the parent component and allow chaining on the returned component.

data/lib/rails/generators/abstract_generator.rb

@@ -44,7 +44,7 @@ module ViewComponent
     end
 
     def sidecar?
-      options["sidecar"] || ViewComponent::Base.generate_sidecar
+      options["sidecar"] || ViewComponent::Base.generate.sidecar
     end
   end
 end

data/lib/rails/generators/component/component_generator.rb

@@ -11,11 +11,13 @@ module Rails
 
       argument :attributes, type: :array, default: [], banner: "attribute"
       check_class_collision suffix: "Component"
+
       class_option :inline, type: :boolean, default: false
+      class_option :locale, type: :boolean, default: ViewComponent::Base.generate.locale
       class_option :parent, type: :string, desc: "The parent class for the generated component"
-      class_option :stimulus, type: :boolean, default: ViewComponent::Base.generate_stimulus_controller
+      class_option :preview, type: :boolean, default: ViewComponent::Base.generate.preview
       class_option :sidecar, type: :boolean, default: false
-      class_option :locale, type: :boolean, default: ViewComponent::Base.generate_locale
+      class_option :stimulus, type: :boolean, default: ViewComponent::Base.generate.stimulus_controller
 
       def create_component_file
         template "component.rb", File.join(component_path, class_path, "#{file_name}_component.rb")

data/lib/rails/generators/locale/component_generator.rb

@@ -12,7 +12,7 @@ module Locale
       class_option :sidecar, type: :boolean, default: false
 
       def create_locale_file
-        if ViewComponent::Base.generate_distinct_locale_files
+        if ViewComponent::Base.generate.distinct_locale_files
           I18n.available_locales.each do |locale|
             create_file destination(locale), translations_hash([locale]).to_yaml
           end

data/lib/rails/generators/preview/component_generator.rb

@@ -5,6 +5,7 @@ module Preview
     class ComponentGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path("templates", __dir__)
 
+      argument :attributes, type: :array, default: [], banner: "attribute"
       check_class_collision suffix: "ComponentPreview"
 
       def create_preview_file
@@ -20,6 +21,12 @@ module Preview
       def file_name
         @_file_name ||= super.sub(/_component\z/i, "")
       end
+
+      def render_signature
+        return if attributes.blank?
+
+        attributes.map { |attr| %(#{attr.name}: "#{attr.name}") }.join(", ")
+      end
     end
   end
 end

data/lib/rails/generators/preview/templates/component_preview.rb.tt

@@ -1,5 +1,7 @@
+# frozen_string_literal: true
+
 class <%= class_name %>ComponentPreview < ViewComponent::Preview
   def default
-    render(<%= class_name %>Component.new)
+    render(<%= class_name %>Component.new<%= "(#{render_signature})" if render_signature %>)
   end
 end

data/lib/rails/generators/rspec/templates/component_spec.rb.tt

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "rails_helper"
 
 RSpec.describe <%= class_name %>Component, type: :component do

data/lib/rails/generators/test_unit/templates/component_test.rb.tt

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require "test_helper"
 
 class <%= class_name %>ComponentTest < ViewComponent::TestCase

data/lib/view_component/base.rb

@@ -40,6 +40,23 @@ module ViewComponent
       # noop
     end
 
+    # @!macro [attach] deprecated_generate_mattr_accessor
+    #   @method generate_$1
+    #   @deprecated Use `#generate.$1` instead. Will be removed in v3.0.0.
+    def self._deprecated_generate_mattr_accessor(name)
+      define_singleton_method("generate_#{name}".to_sym) do
+        generate.public_send(name)
+      end
+      define_singleton_method("generate_#{name}=".to_sym) do |value|
+        generate.public_send("#{name}=".to_sym, value)
+      end
+    end
+
+    _deprecated_generate_mattr_accessor :distinct_locale_files
+    _deprecated_generate_mattr_accessor :locale
+    _deprecated_generate_mattr_accessor :sidecar
+    _deprecated_generate_mattr_accessor :stimulus_controller
+
     # Entrypoint for rendering components.
     #
     # - `view_context`: ActionView context from calling view
@@ -49,11 +66,11 @@ module ViewComponent
     #
     # @return [String]
     def render_in(view_context, &block)
-      self.class.compile(raise_errors: true)
-
       @view_context = view_context
       self.__vc_original_view_context ||= view_context
 
+      @output_buffer = ActionView::OutputBuffer.new unless @global_buffer_in_use
+
       @lookup_context ||= view_context.lookup_context
 
       # required for path helpers in older Rails versions
@@ -87,7 +104,7 @@ module ViewComponent
       before_render
 
       if render?
-        render_template_for(@__vc_variant).to_s + _output_postamble
+        perform_render
       else
         ""
       end
@@ -95,6 +112,20 @@ module ViewComponent
       @current_template = old_current_template
     end
 
+    def perform_render
+      render_template_for(@__vc_variant).to_s + _output_postamble
+    end
+
+    # :nocov:
+    def render_template_for(variant = nil)
+      # Force compilation here so the compiler always redefines render_template_for.
+      # This is mostly a safeguard to prevent infinite recursion.
+      self.class.compile(raise_errors: true, force: true)
+      # .compile replaces this method; call the new one
+      render_template_for(variant)
+    end
+    # :nocov:
+
     # EXPERIMENTAL: Optional content to be returned after the rendered template.
     #
     # @return [String]
@@ -218,14 +249,11 @@ module ViewComponent
     # @param variant [Symbol] The variant to be used by the component.
     # @return [self]
     def with_variant(variant)
-      ActiveSupport::Deprecation.warn(
-        "`with_variant` is deprecated and will be removed in ViewComponent v3.0.0."
-      )
-
       @__vc_variant = variant
 
       self
     end
+    deprecate :with_variant, deprecator: ViewComponent::Deprecation
 
     # The current request. Use sparingly as doing so introduces coupling that
     # inhibits encapsulation & reuse, often making testing difficult.
@@ -271,56 +299,63 @@ module ViewComponent
     #
     mattr_accessor :render_monkey_patch_enabled, instance_writer: false, default: true
 
-    # Always generate a Stimulus controller alongside the component:
+    # Path for component files
     #
-    #     config.view_component.generate_stimulus_controller = true
+    #     config.view_component.view_component_path = "app/my_components"
     #
-    # Defaults to `false`.
+    # Defaults to `app/components`.
     #
-    mattr_accessor :generate_stimulus_controller, instance_writer: false, default: false
+    mattr_accessor :view_component_path, instance_writer: false, default: "app/components"
 
-    # Always generate translations file alongside the component:
+    # Parent class for generated components
     #
-    #     config.view_component.generate_locale = true
+    #     config.view_component.component_parent_class = "MyBaseComponent"
     #
-    # Defaults to `false`.
+    # Defaults to nil. If this is falsy, generators will use
+    # "ApplicationComponent" if defined, "ViewComponent::Base" otherwise.
     #
-    mattr_accessor :generate_locale, instance_writer: false, default: false
+    mattr_accessor :component_parent_class, instance_writer: false
 
-    # Always generate as many translations files as available locales:
+    # Configuration for generators.
     #
-    #     config.view_component.generate_distinct_locale_files = true
+    # All options under this namespace default to `false` unless otherwise
+    # stated.
     #
-    # Defaults to `false`.
+    # #### #sidecar
     #
-    # One file will be generated for each configured `I18n.available_locales`.
-    # Fallback on `[:en]` when no available_locales is defined.
+    # Always generate a component with a sidecar directory:
     #
-    mattr_accessor :generate_distinct_locale_files, instance_writer: false, default: false
-
-    # Path for component files
+    #     config.view_component.generate.sidecar = true
     #
-    #     config.view_component.view_component_path = "app/my_components"
+    # #### #stimulus_controller
     #
-    # Defaults to `app/components`.
+    # Always generate a Stimulus controller alongside the component:
     #
-    mattr_accessor :view_component_path, instance_writer: false, default: "app/components"
-
-    # Parent class for generated components
+    #     config.view_component.generate.stimulus_controller = true
     #
-    #     config.view_component.component_parent_class = "MyBaseComponent"
+    # #### #locale
+    #
+    # Always generate translations file alongside the component:
     #
-    # Defaults to "ApplicationComponent" if defined, "ViewComponent::Base" otherwise.
+    #     config.view_component.generate.locale = true
     #
-    mattr_accessor :component_parent_class, instance_writer: false
-
-    # Always generate a component with a sidecar directory:
+    # #### #distinct_locale_files
+    #
+    # Always generate as many translations files as available locales:
     #
-    #     config.view_component.generate_sidecar = true
+    #     config.view_component.generate.distinct_locale_files = true
     #
-    # Defaults to `false`.
+    # One file will be generated for each configured `I18n.available_locales`,
+    # falling back to `[:en]` when no `available_locales` is defined.
     #
-    mattr_accessor :generate_sidecar, instance_writer: false, default: false
+    # #### #preview
+    #
+    # Always generate preview alongside the component:
+    #
+    #      config.view_component.generate.preview = true
+    #
+    #  Defaults to `false`.
+    mattr_accessor :generate, instance_writer: false, default: ActiveSupport::OrderedOptions.new(false)
 
     class << self
       # @private
@@ -392,6 +427,22 @@ module ViewComponent
         # `compile` defines
         compile
 
+        # Give the child its own personal #render_template_for to protect against the case when
+        # eager loading is disabled and the parent component is rendered before the child. In
+        # such a scenario, the parent will override ViewComponent::Base#render_template_for,
+        # meaning it will not be called for any children and thus not compile their templates.
+        if !child.instance_methods(false).include?(:render_template_for) && !child.compiled?
+          child.class_eval <<~RUBY, __FILE__, __LINE__ + 1
+            def render_template_for(variant = nil)
+              # Force compilation here so the compiler always redefines render_template_for.
+              # This is mostly a safeguard to prevent infinite recursion.
+              self.class.compile(raise_errors: true, force: true)
+              # .compile replaces this method; call the new one
+              render_template_for(variant)
+            end
+          RUBY
+        end
+
         # If Rails application is loaded, add application url_helpers to the component context
         # we need to check this to use this gem as a dependency
         if defined?(Rails) && Rails.application
@@ -424,8 +475,8 @@ module ViewComponent
       # Do as much work as possible in this step, as doing so reduces the amount
       # of work done each time a component is rendered.
       # @private
-      def compile(raise_errors: false)
-        compiler.compile(raise_errors: raise_errors)
+      def compile(raise_errors: false, force: false)
+        compiler.compile(raise_errors: raise_errors, force: force)
       end
 
       # @private

data/lib/view_component/compile_cache.rb

@@ -20,10 +20,11 @@ module ViewComponent
 
     def invalidate_class!(klass)
       cache.delete(klass)
+      klass.compiler.reset_render_template_for
     end
 
     def invalidate!
-      cache.clear
+      cache.each { |klass| invalidate_class!(klass) }
     end
   end
 end

data/lib/view_component/compiler.rb

@@ -27,12 +27,11 @@ module ViewComponent
       self.class.mode == DEVELOPMENT_MODE
     end
 
-    def compile(raise_errors: false)
-      return if compiled?
+    def compile(raise_errors: false, force: false)
+      return if compiled? && !force
+      return if component_class == ViewComponent::Base
 
       with_lock do
-        CompileCache.invalidate_class!(component_class)
-
         subclass_instance_methods = component_class.instance_methods(false)
 
         if subclass_instance_methods.include?(:with_content) && raise_errors
@@ -49,7 +48,7 @@ module ViewComponent
         end
 
         if subclass_instance_methods.include?(:before_render_check)
-          ActiveSupport::Deprecation.warn(
+          ViewComponent::Deprecation.warn(
             "`#before_render_check` will be removed in v3.0.0.\n\n" \
             "To fix this issue, use `#before_render` instead."
           )
@@ -65,13 +64,12 @@ module ViewComponent
           # as Ruby warns when redefining a method.
           method_name = call_method_name(template[:variant])
 
-          if component_class.instance_methods.include?(method_name.to_sym)
-            component_class.send(:undef_method, method_name.to_sym)
+          if component_class.instance_methods(false).include?(method_name.to_sym)
+            component_class.send(:remove_method, method_name.to_sym)
           end
 
-          component_class.class_eval <<-RUBY, template[:path], -1
+          component_class.class_eval <<-RUBY, template[:path], 0
           def #{method_name}
-            @output_buffer = ActionView::OutputBuffer.new
             #{compiled_template(template[:path])}
           end
           RUBY
@@ -93,14 +91,18 @@ module ViewComponent
       end
     end
 
+    def reset_render_template_for
+      if component_class.instance_methods(false).include?(:render_template_for)
+        component_class.send(:remove_method, :render_template_for)
+      end
+    end
+
     private
 
     attr_reader :component_class
 
     def define_render_template_for
-      if component_class.instance_methods.include?(:render_template_for)
-        component_class.send(:undef_method, :render_template_for)
-      end
+      reset_render_template_for
 
       variant_elsifs = variants.compact.uniq.map do |variant|
         "elsif variant.to_sym == :#{variant}\n    #{call_method_name(variant)}"

data/lib/view_component/content_areas.rb

@@ -31,7 +31,7 @@ module ViewComponent
 
     class_methods do
       def with_content_areas(*areas)
-        ActiveSupport::Deprecation.warn(
+        ViewComponent::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."
         )

data/lib/view_component/deprecation.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require "active_support/deprecation"
+
+module ViewComponent
+  DEPRECATION_HORIZON = 3
+  Deprecation = ActiveSupport::Deprecation.new(DEPRECATION_HORIZON.to_s, "ViewComponent")
+end

data/lib/view_component/docs_builder_component.html.erb

@@ -0,0 +1,18 @@
+---
+layout: default
+title: API
+nav_order: 3
+---
+
+<!-- Warning: AUTO-GENERATED file, don't edit. Add code comments to your Ruby instead <3 -->
+
+# API
+
+<% @sections.each do |section| %>
+## <%= section.heading %>
+
+<% section.methods.each do |method| %>
+### <%== render ViewComponent::DocsBuilderComponent::MethodDoc.new(method) %>
+
+<% end %>
+<% end %>

data/lib/view_component/docs_builder_component.rb

@@ -0,0 +1,77 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  class DocsBuilderComponent < Base
+    class Section < Struct.new(:heading, :methods, :show_types, keyword_init: true)
+      def initialize(heading: nil, methods: [], show_types: true)
+        methods.sort_by! { |method| method[:name] }
+        super
+      end
+    end
+
+    class MethodDoc < ViewComponent::Base
+      def initialize(method, section: Section.new(show_types: true))
+        @method = method
+        @section = section
+      end
+
+      def show_types?
+        @section.show_types
+      end
+
+      def deprecated?
+        @method.tag(:deprecated).present?
+      end
+
+      def suffix
+        " (Deprecated)" if deprecated?
+      end
+
+      def types
+        " → [#{@method.tag(:return).types.join(',')}]" if @method.tag(:return)&.types && show_types?
+      end
+
+      def signature_or_name
+        @method.signature ? @method.signature.gsub("def ", "") : @method.name
+      end
+
+      def separator
+        @method.sep
+      end
+
+      def docstring
+        @method.docstring
+      end
+
+      def deprecation_text
+        @method.tag(:deprecated)&.text
+      end
+
+      def docstring_and_deprecation_text
+        <<~DOCS.strip
+          #{docstring}
+
+          #{"_#{deprecation_text}_" if deprecated?}
+        DOCS
+      end
+
+      def call
+        <<~DOCS.chomp
+          #{separator}#{signature_or_name}#{types}#{suffix}
+
+          #{docstring_and_deprecation_text}
+        DOCS
+      end
+    end
+
+    # { heading: String, public_only: Boolean, show_types: Boolean}
+    def initialize(sections: [])
+      @sections = sections
+    end
+
+    # deprecation
+    # return
+    # only public methods
+    # sig with types or name
+  end
+end

data/lib/view_component/engine.rb

@@ -20,6 +20,7 @@ module ViewComponent
       options.instrumentation_enabled = false if options.instrumentation_enabled.nil?
       options.preview_route ||= ViewComponent::Base.preview_route
       options.preview_controller ||= ViewComponent::Base.preview_controller
+      options.use_global_output_buffer = false if options.use_global_output_buffer.nil?
 
       if options.show_previews
         options.preview_paths << "#{Rails.root}/test/components/previews" if defined?(Rails.root) && Dir.exist?(
@@ -27,7 +28,7 @@ module ViewComponent
         )
 
         if options.preview_path.present?
-          ActiveSupport::Deprecation.warn(
+          ViewComponent::Deprecation.warn(
             "`preview_path` will be removed in v3.0.0. Use `preview_paths` instead."
           )
           options.preview_paths << options.preview_path
@@ -57,6 +58,21 @@ module ViewComponent
       end
     end
 
+    initializer "view_component.enable_global_output_buffer" do |app|
+      ActiveSupport.on_load(:view_component) do
+        env_use_gob = ENV.fetch("VIEW_COMPONENT_USE_GLOBAL_OUTPUT_BUFFER", "false") == "true"
+        config_use_gob = app.config.view_component.use_global_output_buffer
+
+        if config_use_gob || env_use_gob
+          # :nocov:
+          app.config.view_component.use_global_output_buffer = true
+          ViewComponent::Base.prepend(ViewComponent::GlobalOutputBuffer)
+          ActionView::Base.prepend(ViewComponent::GlobalOutputBuffer::ActionViewMods)
+          # :nocov:
+        end
+      end
+    end
+
     initializer "view_component.set_autoload_paths" do |app|
       options = app.config.view_component
 
@@ -155,7 +171,9 @@ end
 
 # :nocov:
 unless defined?(ViewComponent::Base)
-  ActiveSupport::Deprecation.warn(
+  require "view_component/deprecation"
+
+  ViewComponent::Deprecation.warn(
     "This manually engine loading is deprecated and will be removed in v3.0.0. " \
     "Remove `require \"view_component/engine\"`."
   )

data/lib/view_component/global_output_buffer.rb

@@ -0,0 +1,99 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module GlobalOutputBuffer
+    def render_in(view_context, &block)
+      unless view_context.output_buffer.is_a?(OutputBufferStack)
+        # use instance_variable_set here to avoid triggering the code in the #output_buffer= method below
+        view_context.instance_variable_set(:@output_buffer, OutputBufferStack.new(view_context.output_buffer))
+      end
+
+      @output_buffer = view_context.output_buffer
+      @global_buffer_in_use = true
+
+      super(view_context, &block)
+    end
+
+    def perform_render
+      # HAML unhelpfully assigns to @output_buffer directly, so we hold onto a reference to
+      # it and restore @output_buffer when the HAML engine is finished. In non-HAML cases,
+      # @output_buffer and orig_buf will point to the same object, making the reassignment
+      # statements no-ops.
+      orig_buf = @output_buffer
+      @output_buffer.push
+      result = render_template_for(@__vc_variant).to_s + _output_postamble
+      @output_buffer = orig_buf
+      @output_buffer.pop
+      result
+    end
+
+    def output_buffer=(other_buffer)
+      @output_buffer.replace(other_buffer)
+    end
+
+    def with_output_buffer(buf = nil)
+      unless buf
+        buf = ActionView::OutputBuffer.new
+        if output_buffer && output_buffer.respond_to?(:encoding)
+          buf.force_encoding(output_buffer.encoding)
+        end
+      end
+
+      output_buffer.push(buf)
+      result = nil
+
+      begin
+        yield
+      ensure
+        # assign result here to avoid a return statement, which will
+        # immediately return to the caller and swallow any errors
+        result = output_buffer.pop
+      end
+
+      result
+    end
+
+    module ActionViewMods
+      def output_buffer=(other_buffer)
+        if @output_buffer.is_a?(OutputBufferStack)
+          @output_buffer.replace(other_buffer)
+        else
+          super
+        end
+      end
+
+      def with_output_buffer(buf = nil)
+        unless buf
+          buf = ActionView::OutputBuffer.new
+          if @output_buffer && @output_buffer.respond_to?(:encoding)
+            buf.force_encoding(@output_buffer.encoding)
+          end
+        end
+
+        result = nil
+
+        if @output_buffer.is_a?(OutputBufferStack)
+          @output_buffer.push(buf)
+
+          begin
+            yield
+          ensure
+            result = @output_buffer.pop
+          end
+
+          result
+        else
+          @output_buffer, old_buffer = buf, output_buffer
+
+          begin
+            yield
+          ensure
+            @output_buffer = old_buffer
+          end
+
+          buf
+        end
+      end
+    end
+  end
+end

data/lib/view_component/output_buffer_stack.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  class OutputBufferStack
+    delegate_missing_to :@current_buffer
+    delegate :presence, :present?, :html_safe?, to: :@current_buffer
+
+    attr_reader :buffer_stack
+
+    def self.make_frame(*args)
+      ActionView::OutputBuffer.new(*args)
+    end
+
+    def initialize(initial_buffer = nil)
+      if initial_buffer.is_a?(self.class)
+        @current_buffer = self.class.make_frame(initial_buffer.current)
+        @buffer_stack = [*initial_buffer.buffer_stack[0..-2], @current_buffer]
+      else
+        @current_buffer = initial_buffer || self.class.make_frame
+        @buffer_stack = [@current_buffer]
+      end
+    end
+
+    def replace(buffer)
+      return if self == buffer
+
+      @current_buffer = buffer.current
+      @buffer_stack = buffer.buffer_stack
+    end
+
+    def append=(arg)
+      @current_buffer.append = arg
+    end
+
+    def safe_append=(arg)
+      @current_buffer.safe_append = arg
+    end
+
+    def safe_concat(arg)
+      # rubocop:disable Rails/OutputSafety
+      @current_buffer.safe_concat(arg)
+      # rubocop:enable Rails/OutputSafety
+    end
+
+    def length
+      @current_buffer.length
+    end
+
+    def push(buffer = nil)
+      buffer ||= self.class.make_frame
+      @buffer_stack.push(buffer)
+      @current_buffer = buffer
+    end
+
+    def pop
+      @buffer_stack.pop.tap do
+        @current_buffer = @buffer_stack.last
+      end
+    end
+
+    def to_s
+      @current_buffer
+    end
+
+    alias_method :current, :to_s
+  end
+end

data/lib/view_component/polymorphic_slots.rb

@@ -25,12 +25,19 @@ module ViewComponent
       end
 
       def register_polymorphic_slot(slot_name, types, collection:)
+        unless types.empty?
+          getter_name = slot_name
+
+          define_method(getter_name) do
+            get_slot(slot_name)
+          end
+        end
+
         renderable_hash = types.each_with_object({}) do |(poly_type, poly_callable), memo|
           memo[poly_type] = define_slot(
             "#{slot_name}_#{poly_type}", collection: collection, callable: poly_callable
           )
 
-          getter_name = slot_name
           setter_name =
             if collection
               "#{ActiveSupport::Inflector.singularize(slot_name)}_#{poly_type}"
@@ -38,10 +45,6 @@ module ViewComponent
               "#{slot_name}_#{poly_type}"
             end
 
-          define_method(getter_name) do
-            get_slot(slot_name)
-          end
-
           define_method(setter_name) do |*args, &block|
             set_polymorphic_slot(slot_name, poly_type, *args, &block)
           end

data/lib/view_component/preview.rb

@@ -73,8 +73,8 @@ 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
+          Array(preview_paths).detect do |path|
+            Dir["#{path}/#{preview_name}_preview/#{example}.html.*"].first
           end
 
         if preview_path.nil?

data/lib/view_component/slot_v2.rb

@@ -45,18 +45,12 @@ module ViewComponent
           if defined?(@__vc_content_set_by_with_content)
             @__vc_component_instance.with_content(@__vc_content_set_by_with_content)
 
-            view_context.capture do
-              @__vc_component_instance.render_in(view_context)
-            end
+            @__vc_component_instance.render_in(view_context)
           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
+            # render_in is faster than `parent.render`
+            @__vc_component_instance.render_in(view_context, &@__vc_content_block)
           else
-            view_context.capture do
-              @__vc_component_instance.render_in(view_context)
-            end
+            @__vc_component_instance.render_in(view_context)
           end
         elsif defined?(@__vc_content)
           @__vc_content

data/lib/view_component/slotable.rb

@@ -23,7 +23,7 @@ module ViewComponent
       #   class_name: "Header" # class name string, used to instantiate Slot
       # )
       def with_slot(*slot_names, collection: false, class_name: nil)
-        ActiveSupport::Deprecation.warn(
+        ViewComponent::Deprecation.warn(
           "`with_slot` is deprecated and will be removed in ViewComponent v3.0.0.\n" \
           "Use the new slots API (https://viewcomponent.org/guide/slots.html) instead."
         )

data/lib/view_component/slotable_v2.rb

@@ -7,6 +7,11 @@ module ViewComponent
   module SlotableV2
     extend ActiveSupport::Concern
 
+    RESERVED_NAMES = {
+      singular: %i[content render].freeze,
+      plural: %i[contents renders].freeze,
+    }.freeze
+
     # Setup component slot state
     included do
       # Hash of registered Slots
@@ -75,6 +80,10 @@ module ViewComponent
         end
         ruby2_keywords(slot_name.to_sym) if respond_to?(:ruby2_keywords, true)
 
+        define_method "#{slot_name}?" do
+          get_slot(slot_name).present?
+        end
+
         register_slot(slot_name, collection: false, callable: callable)
       end
 
@@ -140,6 +149,10 @@ module ViewComponent
           end
         end
 
+        define_method "#{slot_name}?" do
+          get_slot(slot_name).present?
+        end
+
         register_slot(slot_name, collection: true, callable: callable)
       end
 
@@ -197,24 +210,26 @@ module ViewComponent
       end
 
       def validate_plural_slot_name(slot_name)
-        if slot_name.to_sym == :contents
+        if RESERVED_NAMES[:plural].include?(slot_name.to_sym)
           raise ArgumentError.new(
             "#{self} 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."
           )
         end
 
+        raise_if_slot_ends_with_question_mark(slot_name)
         raise_if_slot_registered(slot_name)
       end
 
       def validate_singular_slot_name(slot_name)
-        if slot_name.to_sym == :content
+        if RESERVED_NAMES[:singular].include?(slot_name.to_sym)
           raise ArgumentError.new(
             "#{self} 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."
           )
         end
 
+        raise_if_slot_ends_with_question_mark(slot_name)
         raise_if_slot_registered(slot_name)
       end
 
@@ -227,6 +242,17 @@ module ViewComponent
           )
         end
       end
+
+      def raise_if_slot_ends_with_question_mark(slot_name)
+        if slot_name.to_s.ends_with?("?")
+          raise ArgumentError.new(
+            "#{self} declares a slot named #{slot_name}, which ends with a question mark.\n\n"\
+            "This is not allowed because the ViewComponent framework already provides predicate "\
+            "methods ending in `?`.\n\n" \
+            "To fix this issue, choose a different name."
+          )
+        end
+      end
     end
 
     def get_slot(slot_name)
@@ -276,8 +302,8 @@ module ViewComponent
         renderable_function = slot_definition[:renderable_function].bind(self)
         renderable_value =
           if block_given?
-            renderable_function.call(*args) do |*args|
-              view_context.capture(*args, &block)
+            renderable_function.call(*args) do |*rargs|
+              view_context.capture(*rargs, &block)
             end
           else
             renderable_function.call(*args)

data/lib/view_component/translatable.rb

@@ -87,7 +87,7 @@ module ViewComponent
         end
 
         if HTML_SAFE_TRANSLATION_KEY.match?(key)
-          translated = translated.html_safe # rubocop:disable Rails/OutputSafety
+          translated = html_safe_translation(translated)
         end
 
         translated

data/lib/view_component/version.rb

@@ -3,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 49
-    PATCH = 1
+    MINOR = 52
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

data/lib/view_component.rb

@@ -10,7 +10,10 @@ module ViewComponent
   autoload :Compiler
   autoload :CompileCache
   autoload :ComponentError
+  autoload :Deprecation
+  autoload :GlobalOutputBuffer
   autoload :Instrumentation
+  autoload :OutputBufferStack
   autoload :Preview
   autoload :PreviewTemplateError
   autoload :TestHelpers
@@ -21,8 +24,8 @@ end
 
 # :nocov:
 if defined?(ViewComponent::Engine)
-  ActiveSupport::Deprecation.warn(
-    "This manually engine loading is deprecated and will be removed in v3.0.0. " \
+  ViewComponent::Deprecation.warn(
+    "Manually loading the engine is deprecated and will be removed in v3.0.0. " \
     "Remove `require \"view_component/engine\"`."
   )
 elsif defined?(Rails::Engine)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.49.1
+  version: 2.52.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-02 00:00:00.000000000 Z
+date: 2022-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -329,8 +329,13 @@ files:
 - lib/view_component/compiler.rb
 - lib/view_component/component_error.rb
 - lib/view_component/content_areas.rb
+- lib/view_component/deprecation.rb
+- lib/view_component/docs_builder_component.html.erb
+- lib/view_component/docs_builder_component.rb
 - lib/view_component/engine.rb
+- lib/view_component/global_output_buffer.rb
 - lib/view_component/instrumentation.rb
+- lib/view_component/output_buffer_stack.rb
 - lib/view_component/polymorphic_slots.rb
 - lib/view_component/preview.rb
 - lib/view_component/preview_template_error.rb