view_component 2.61.1 → 2.64.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f405812996b460c943dba2ae0802dbc7e924ce3ae45ff69eb917333c77ecb890
-  data.tar.gz: b50121e18674aa4c5f7b569cc4c2edb5078d4685192e8154d4654b4b21a03ef6
+  metadata.gz: 1cee1c1b53cec5fec9d4613416a27999c653c2cf8fb176798b235c7b71dc795d
+  data.tar.gz: 5fb8a364788849fecfb8bb2160ebd6dc403f624ba6b3fe13c818706f928b8257
 SHA512:
-  metadata.gz: 23b295998753b2f0d17af1ee5cbc18ec0602cafa48c1ca4ee19568073c38453c79b7aadd1ec42160eab0b522d4a5c3c10f8682a224ed771b4ff25da1e97730fa
-  data.tar.gz: 43e4f27eb614d7de04e6b44747e4d7f2c006367cae62b2b3dc7ad67bdc6a22ea9ea7822308895b704bd19a50879d3bb3ecf2f0209adb9f039eb149217ef479b5
+  metadata.gz: d721f8d07af64e314a506afc364941f95d3b824d27e587e12d8c774f4fa168b7ae00ac400c4f73b546ed0d5728aec60d586e52dacaee2b8f10e01230bbe3ab8f
+  data.tar.gz: 598ab2f08524a8eb10b17a001ed7429223ca39ab204c25cec4375ea201e3afa1c852ba1578f81a1de5c83211e1eb05f3c1a7d146f83cc1d77e3f4ed0bfdef962

data/docs/CHANGELOG.md

@@ -9,6 +9,64 @@ title: Changelog
 
 ## main
 
+## 2.64.0
+
+* Add `warn_on_deprecated_slot_setter` flag to opt-in to deprecation warning.
+
+    In [v2.54.0](https://viewcomponent.org/CHANGELOG.html#2540), the Slots API was updated to require the `with_*` prefix for setting Slots. The non-`with_*` setters will be deprecated in a coming version and removed in `v3.0`.
+
+    To enable the coming deprecation warning, add `warn_on_deprecated_slot_setter`:
+
+    ```ruby
+    class DeprecatedSlotsSetterComponent < ViewComponent::Base
+      warn_on_deprecated_slot_setter
+    end
+    ```
+
+    *Joel Hawksley*
+
+* Add [`m`](https://rubygems.org/gems/m) to development environment.
+
+    *Joel Hawksley*
+
+* Fix potential deadlock scenario in the compiler's development mode.
+
+    *Blake Williams*
+
+## 2.63.0
+
+* Fixed typo in `renders_many` documentation.
+
+    *Graham Rogers*
+
+* Add documentation about working with `turbo-rails`.
+
+    *Matheus Poli Camilo*
+
+* Fix issue causing helper methods to not be available in nested components when the render monkey patch is disabled and `render_component` is used.
+
+    *Daniel Scheffknecht*
+
+## 2.62.0
+
+* Remove the experimental global output buffer feature.
+* Restore functionality that used to attempt to compile templates on each call to `#render_in`.
+* Un-pin `rails` `main` dependency.
+
+    *Cameron Dutro*
+
+* Add blank space between "in" and "ViewComponent" in a deprecation warning.
+
+    *Vikram Dighe*
+
+* Add HappyCo to list of companies using ViewComponent.
+
+    *Josh Clayton*
+
+* Add predicate method support to polymorphic slots.
+
+    *Graham Rogers*
+
 ## 2.61.1
 
 * Revert `Expose Capybara DSL methods directly inside tests.` This change unintentionally broke other Capybara methods and thus introduced a regression. We aren't confident that we can fail forward so we have decided to revert this change.

data/lib/view_component/base.rb

@@ -86,10 +86,12 @@ 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 defined?(@global_buffer_in_use) && @global_buffer_in_use
+      @output_buffer = ActionView::OutputBuffer.new
 
       @lookup_context ||= view_context.lookup_context
 
@@ -124,7 +126,7 @@ module ViewComponent
       before_render
 
       if render?
-        perform_render
+        render_template_for(@__vc_variant).to_s + _output_postamble
       else
         ""
       end
@@ -132,11 +134,6 @@ module ViewComponent
       @current_template = old_current_template
     end
 
-    # @private
-    def perform_render
-      render_template_for(@__vc_variant).to_s + _output_postamble
-    end
-
     # Subclass components that call `super` inside their template code will cause a
     # double render if they emit the result:
     #
@@ -152,17 +149,6 @@ module ViewComponent
       nil
     end
 
-    # @private
-    # :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]

data/lib/view_component/compile_cache.rb

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

data/lib/view_component/compiler.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "concurrent-ruby"
+
 module ViewComponent
   class Compiler
     # Lock required to be obtained before compiling the component
@@ -16,7 +18,7 @@ module ViewComponent
 
     def initialize(component_class)
       @component_class = component_class
-      @__vc_compiler_lock = Monitor.new
+      @__vc_compiler_lock = Concurrent::ReadWriteLock.new
     end
 
     def compiled?
@@ -33,7 +35,9 @@ module ViewComponent
 
       component_class.superclass.compile(raise_errors: raise_errors) if should_compile_superclass?
 
-      with_lock do
+      with_write_lock do
+        CompileCache.invalidate_class!(component_class)
+
         subclass_instance_methods = component_class.instance_methods(false)
 
         if subclass_instance_methods.include?(:with_content) && raise_errors
@@ -66,8 +70,8 @@ module ViewComponent
           # as Ruby warns when redefining a method.
           method_name = call_method_name(template[:variant])
 
-          if component_class.instance_methods(false).include?(method_name.to_sym)
-            component_class.send(:remove_method, method_name.to_sym)
+          if component_class.instance_methods.include?(method_name.to_sym)
+            component_class.send(:undef_method, method_name.to_sym)
           end
 
           # rubocop:disable Style/EvalWithLocation
@@ -88,18 +92,16 @@ module ViewComponent
       end
     end
 
-    def with_lock(&block)
+    def with_write_lock(&block)
       if development?
-        __vc_compiler_lock.synchronize(&block)
+        __vc_compiler_lock.with_write_lock(&block)
       else
         block.call
       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
+    def with_read_lock(&block)
+      __vc_compiler_lock.with_read_lock(&block)
     end
 
     private
@@ -107,7 +109,9 @@ module ViewComponent
     attr_reader :component_class
 
     def define_render_template_for
-      reset_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)}"
@@ -125,7 +129,7 @@ module ViewComponent
       if development?
         component_class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def render_template_for(variant = nil)
-          self.class.compiler.with_lock do
+          self.class.compiler.with_read_lock do
             #{body}
           end
         end

data/lib/view_component/engine.rb

@@ -20,7 +20,6 @@ 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?(
@@ -58,21 +57,6 @@ 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/polymorphic_slots.rb

@@ -42,6 +42,10 @@ module ViewComponent
           define_method(getter_name) do
             get_slot(slot_name)
           end
+
+          define_method("#{getter_name}?") do
+            get_slot(slot_name).present?
+          end
         end
 
         renderable_hash = types.each_with_object({}) do |(poly_type, poly_callable), memo|
@@ -57,10 +61,12 @@ module ViewComponent
             end
 
           define_method(setter_name) do |*args, &block|
-            ViewComponent::Deprecation.warn(
-              "polymorphic slot setters like `#{setter_name}` are deprecated and will be removed in" \
-              "ViewComponent v3.0.0.\n\nUse `with_#{setter_name}` instead."
-            )
+            if _warn_on_deprecated_slot_setter
+              ViewComponent::Deprecation.warn(
+                "polymorphic slot setters like `#{setter_name}` are deprecated and will be removed in " \
+                "ViewComponent v3.0.0.\n\nUse `with_#{setter_name}` instead."
+              )
+            end
 
             set_polymorphic_slot(slot_name, poly_type, *args, &block)
           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/slotable_v2.rb

@@ -17,9 +17,19 @@ module ViewComponent
       # Hash of registered Slots
       class_attribute :registered_slots
       self.registered_slots = {}
+
+      class_attribute :_warn_on_deprecated_slot_setter
+      self._warn_on_deprecated_slot_setter = false
     end
 
     class_methods do
+      ##
+      # Enables deprecations coming to the Slots API in ViewComponent v3
+      #
+      def warn_on_deprecated_slot_setter
+        self._warn_on_deprecated_slot_setter = true
+      end
+
       ##
       # Registers a sub-component
       #
@@ -80,7 +90,13 @@ module ViewComponent
           if args.empty? && block.nil?
             get_slot(slot_name)
           else
-            # Deprecated: Will remove in 3.0
+            if _warn_on_deprecated_slot_setter
+              ViewComponent::Deprecation.warn(
+                "Setting a slot with `##{slot_name}` is deprecated and will be removed in ViewComponent v3.0.0. " \
+                "Use `#with_#{slot_name}` to set the slot instead."
+              )
+            end
+
             set_slot(slot_name, nil, *args, &block)
           end
         end
@@ -98,11 +114,11 @@ module ViewComponent
       #
       # = Example
       #
-      #   render_many :items, -> (name:) { ItemComponent.new(name: name }
+      #   renders_many :items, -> (name:) { ItemComponent.new(name: name }
       #
       #   # OR
       #
-      #   render_many :items, ItemComponent
+      #   renders_many :items, ItemComponent
       #
       # = Rendering sub-components
       #
@@ -138,9 +154,15 @@ module ViewComponent
         # Define setter for singular names
         # for example `renders_many :items` allows fetching all tabs with
         # `component.tabs` and setting a tab with `component.tab`
-        #
-        # Deprecated: Will remove in 3.0
+
         define_method singular_name do |*args, &block|
+          if _warn_on_deprecated_slot_setter
+            ViewComponent::Deprecation.warn(
+              "Setting a slot with `##{singular_name}` is deprecated and will be removed in ViewComponent v3.0.0. " \
+              "Use `#with_#{singular_name}` to set the slot instead."
+            )
+          end
+
           set_slot(slot_name, nil, *args, &block)
         end
         ruby2_keywords(singular_name.to_sym) if respond_to?(:ruby2_keywords, true)
@@ -162,7 +184,13 @@ module ViewComponent
           if collection_args.nil? && block.nil?
             get_slot(slot_name)
           else
-            # Deprecated: Will remove in 3.0
+            if _warn_on_deprecated_slot_setter
+              ViewComponent::Deprecation.warn(
+                "Setting a slot with `##{slot_name}` is deprecated and will be removed in ViewComponent v3.0.0. " \
+                "Use `#with_#{slot_name}` to set the slot instead."
+              )
+            end
+
             collection_args.map do |args|
               set_slot(slot_name, nil, **args, &block)
             end

data/lib/view_component/version.rb

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

data/lib/view_component.rb

@@ -11,9 +11,7 @@ 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.61.1
+  version: 2.64.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-07-21 00:00:00.000000000 Z
+date: 2022-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: concurrent-ruby
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: appraisal
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +156,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2'
+- !ruby/object:Gem::Dependency
+  name: m
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -334,9 +362,7 @@ 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

data/lib/view_component/global_output_buffer.rb

@@ -1,100 +0,0 @@
-# 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
-        # rubocop:disable Style/SafeNavigation
-        if output_buffer && output_buffer.respond_to?(:encoding)
-          buf.force_encoding(output_buffer.encoding)
-        end
-        # rubocop:enable Style/SafeNavigation
-      end
-
-      output_buffer.push(buf)
-
-      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
-          # rubocop:disable Style/SafeNavigation
-          if @output_buffer && @output_buffer.respond_to?(:encoding)
-            buf.force_encoding(@output_buffer.encoding)
-          end
-          # rubocop:enable Style/SafeNavigation
-        end
-
-        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

@@ -1,65 +0,0 @@
-# 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)
-      @current_buffer.safe_concat(arg)
-    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