view_component 2.51.0 → 2.52.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 163414625d8e2df6f2afddc821a6c849aef71cc8cd1ba458a533d90840e545cc
-  data.tar.gz: 3518269c96d4e62d3bcedae22871c7b260d2abf42e0c1e32703115185e69eeea
+  metadata.gz: 1eb8c14aae22e2977db7cde77cd64f9ff1d69f14c0f2c95b6b2ebf0fabf67f5a
+  data.tar.gz: fe2c729ae013bf1dd2effb17143acfef756e915ea773dcb7eef84fd329c7e002
 SHA512:
-  metadata.gz: 531785b833a4d1a83b6929095b6a6a34076cb6576820884487a247d70c37bde2fedc47914633674c59a888dc7270526660e121f4980f2bcb85625ed6009607c4
-  data.tar.gz: e4c8b2694c7f70c529d56dcced18f66d511e909e1f36abc604a58402d1332caecde59d40c065668454af8abf6d53578469539ac1f4366650ad286856b50776fa
+  metadata.gz: 0e72fac02dd38cd39cfa7fe45bc57617a8088d2016add0c769df9075393dc8fde66ea44c96d466019354585da3754b1db2099e9207a46418b011e6ef8765b816
+  data.tar.gz: 6ec82473f583cd484e9ee4042683d7d605131279ef855a199f1a89292967dd971c6ed8a43f8ad7fc9d519bae02fb4f2e5cf8d14f4876ffa1b524ad41ce25ea20

data/docs/CHANGELOG.md

@@ -7,6 +7,21 @@ 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.

data/lib/view_component/base.rb

@@ -69,6 +69,8 @@ module ViewComponent
       @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
@@ -102,7 +104,7 @@ module ViewComponent
       before_render
 
       if render?
-        render_template_for(@__vc_variant).to_s + _output_postamble
+        perform_render
       else
         ""
       end
@@ -110,6 +112,10 @@ 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.
@@ -421,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

data/lib/view_component/compiler.rb

@@ -68,9 +68,8 @@ module ViewComponent
             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

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?(
@@ -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
 

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/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/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 51
+    MINOR = 52
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

data/lib/view_component.rb

@@ -11,7 +11,9 @@ module ViewComponent
   autoload :CompileCache
   autoload :ComponentError
   autoload :Deprecation
+  autoload :GlobalOutputBuffer
   autoload :Instrumentation
+  autoload :OutputBufferStack
   autoload :Preview
   autoload :PreviewTemplateError
   autoload :TestHelpers

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.51.0
+  version: 2.52.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-19 00:00:00.000000000 Z
+date: 2022-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -333,7 +333,9 @@ files:
 - 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