view_component 4.0.0.alpha1 → 4.0.0.alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8c0d5be4a21f5c14ed5447caeaffb8d6e51397a1ec786f573bc58d9486fc747
-  data.tar.gz: 332de180e52e1b5eae806fb47e9d1dea4a32374cdf63a0642ca69d3661e4c802
+  metadata.gz: d926054ff51767aa08c688eef809327cbbda35e8b403a574af8baa642aefe7ed
+  data.tar.gz: ed0a01b7b1fe98080c4c7210c7bdde4b474d08f4b0c5ab0a36c39e9e6631f185
 SHA512:
-  metadata.gz: e298e8e18d147034b30fb60f32a7bbf5d5f42d1235d5947cfeba4e3e1b8ad65a57379f3a3fb361ba7ffdec727687689ceb98b4b893e038a16ea5496663d4423a
-  data.tar.gz: f6e8f8956abde8eac1e4825c09a2554dde1dd80efac74ba541210e2fe663e23399ddc01289ca44dee21e6c3551b32117b88444d9795fbb450b02639ebc9fadbf
+  metadata.gz: 54aa90e88b7fb9f0773842f0737739c15cfaff4609f62fe733badd14ab8676ec21532c5d00915947ce183aca678f7ed79573f15e8dec06f873067a9585a277ab
+  data.tar.gz: 3c4187ccc4f70942964fedd232fb387314e5f7cfa47624df5def3006ff9478947d4de9380c0baf29b5102e20217de0eb77a9bfe8a21240a79065cb719d02bf94

data/docs/CHANGELOG.md

@@ -10,7 +10,19 @@ nav_order: 6
 
 ## main
 
-## 4.0.0
+## 4.0.0.alpha3
+
+* BREAKING: Remove dependency on `ActionView::Base`, eliminating the need for capture compatibility patch.
+
+    *Cameron Dutro*
+
+## 4.0.0.alpha2
+
+* Add `#current_template` accessor and `Template#path` for diagnostic usage.
+
+    *Joel Hawksley*
+
+## 4.0.0.alpha1
 
 Almost six years after releasing [v1.0.0](https://github.com/ViewComponent/view_component/releases/tag/v1.0.0), we're proud to ship ViewComponent 4. This release marks a shift towards a Long Term Support model for the project, having reached significant feature maturity. While contributions are always welcome, we're unlikely to accept further breaking changes or major feature additions.
 
@@ -112,6 +124,14 @@ This release makes the following breaking changes:
 
     *Tiago Menegaz*, *Joel Hawksley*
 
+* Introduce component-local config and migrate `strip_trailing_whitespace` to use it under the hood.
+
+    *Simon Fish*
+
+* Add docs about Slack channel in Ruby Central workspace. (Join us! #oss-view-component). Email joelhawksley@github.com for an invite.
+
+    *Joel Hawksley
+
 * Do not include internal `DocsBuilderComponent` or `YARD::MattrAccessorHandler` in published gem.
 
     *Joel Hawksley*

data/lib/view_component/base.rb

@@ -5,6 +5,7 @@ require "active_support/configurable"
 require "view_component/collection"
 require "view_component/compile_cache"
 require "view_component/compiler"
+require "view_component/component_local_config"
 require "view_component/config"
 require "view_component/errors"
 require "view_component/inline_template"
@@ -17,8 +18,21 @@ require "view_component/translatable"
 require "view_component/with_content_helper"
 require "view_component/use_helpers"
 
+module ActionView
+  class OutputBuffer
+    def with_buffer(buf = nil)
+      new_buffer = buf || +""
+      old_buffer, @raw_buffer = @raw_buffer, new_buffer
+      yield
+      new_buffer
+    ensure
+      @raw_buffer = old_buffer
+    end
+  end
+end
+
 module ViewComponent
-  class Base < ActionView::Base
+  class Base
     class << self
       delegate(*ViewComponent::Config.defaults.keys, to: :config)
 
@@ -34,22 +48,28 @@ module ViewComponent
       end
     end
 
+    include ActionView::Helpers
+    include ERB::Escape
+    include ActiveSupport::CoreExt::ERBUtil
+
     include ViewComponent::InlineTemplate
     include ViewComponent::UseHelpers
     include ViewComponent::Slotable
     include ViewComponent::Translatable
     include ViewComponent::WithContentHelper
+    include ViewComponent::ComponentLocalConfig
 
     # For CSRF authenticity tokens in forms
     delegate :form_authenticity_token, :protect_against_forgery?, :config, to: :helpers
 
+    # HTML construction methods
+    delegate :output_buffer, :lookup_context, :view_renderer, :view_flow, to: :helpers
+
     # For Content Security Policy nonces
     delegate :content_security_policy_nonce, to: :helpers
 
-    # Config option that strips trailing whitespace in templates before compiling them.
-    class_attribute :__vc_strip_trailing_whitespace, instance_accessor: false, instance_predicate: false, default: false
-
     attr_accessor :__vc_original_view_context
+    attr_reader :current_template
 
     # Components render in their own view context. Helpers and other functionality
     # require a reference to the original Rails view context, an instance of
@@ -61,7 +81,7 @@ module ViewComponent
     # @param view_context [ActionView::Base] The original view context.
     # @return [void]
     def set_original_view_context(view_context)
-      self.__vc_original_view_context = view_context
+      # noop
     end
 
     using RequestDetails
@@ -80,7 +100,7 @@ module ViewComponent
       @view_context = view_context
       self.__vc_original_view_context ||= view_context
 
-      @output_buffer = ActionView::OutputBuffer.new
+      @output_buffer = view_context.output_buffer
 
       @lookup_context ||= view_context.lookup_context
 
@@ -107,14 +127,20 @@ module ViewComponent
       before_render
 
       if render?
-        rendered_template = render_template_for(@__vc_requested_details).to_s
+        value = nil
 
-        # Avoid allocating new string when output_preamble and output_postamble are blank
-        if output_preamble.blank? && output_postamble.blank?
-          rendered_template
-        else
-          safe_output_preamble + rendered_template + safe_output_postamble
+        @output_buffer.with_buffer do
+          rendered_template = render_template_for(@__vc_requested_details).to_s
+
+          # Avoid allocating new string when output_preamble and output_postamble are blank
+          value = if output_preamble.blank? && output_postamble.blank?
+            rendered_template
+          else
+            safe_output_preamble + rendered_template + safe_output_postamble
+          end
         end
+
+        value
       else
         ""
       end
@@ -206,7 +232,7 @@ module ViewComponent
     def render(options = {}, args = {}, &block)
       if options.respond_to?(:set_original_view_context)
         options.set_original_view_context(self.__vc_original_view_context)
-        super
+        @view_context.render(options, args, &block)
       else
         __vc_original_view_context.render(options, args, &block)
       end
@@ -593,16 +619,38 @@ module ViewComponent
       # end
       # ```
       #
+      # @deprecated Use the new component-local configuration option instead.
+      #
+      #   ```ruby
+      #   class MyComponent < ViewComponent::Base
+      #     configure_view_component do |config|
+      #       config.strip_trailing_whitespace = true
+      #     end
+      #   end
+      #   ```
+      #
       # @param value [Boolean] Whether to strip newlines.
       def strip_trailing_whitespace(value = true)
-        self.__vc_strip_trailing_whitespace = value
+        ViewComponent::Deprecation.deprecation_warning(
+          "strip_trailing_whitespace",
+          <<~DOC
+            Use the new component-local configuration option instead:
+
+            class #{self.class.name} < ViewComponent::Base
+              configure_view_component do |config|
+                config.strip_trailing_whitespace = #{value}
+              end
+            end
+          DOC
+        )
+        view_component_config.strip_trailing_whitespace = value
       end
 
       # Whether trailing whitespace will be stripped before compilation.
       #
       # @return [Boolean]
       def strip_trailing_whitespace?
-        __vc_strip_trailing_whitespace
+        view_component_config.strip_trailing_whitespace
       end
 
       # Ensure the component initializer accepts the

data/lib/view_component/collection.rb

@@ -9,15 +9,8 @@ module ViewComponent
 
     delegate :size, to: :@collection
 
-    attr_accessor :__vc_original_view_context
-
-    def set_original_view_context(view_context)
-      self.__vc_original_view_context = view_context
-    end
-
     def render_in(view_context, &block)
       components.map do |component|
-        component.set_original_view_context(__vc_original_view_context)
         component.render_in(view_context, &block)
       end.join(rendered_spacer(view_context)).html_safe
     end
@@ -67,7 +60,6 @@ module ViewComponent
 
     def rendered_spacer(view_context)
       if @spacer_component
-        @spacer_component.set_original_view_context(__vc_original_view_context)
         @spacer_component.render_in(view_context)
       else
         ""

data/lib/view_component/component_local_config.rb

@@ -0,0 +1,60 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module ComponentLocalConfig
+    class Configuration
+      def self.defaults
+        ActiveSupport::Configurable::Configuration[
+          strip_trailing_whitespace: false
+        ]
+      end
+
+      def initialize(config = defaults)
+        @config = config
+      end
+
+      delegate_missing_to :@config
+
+      def inheritable_copy
+        self.class.new(@config.inheritable_copy)
+      end
+
+      private
+
+      delegate :defaults, to: :class
+    end
+
+    extend ActiveSupport::Concern
+
+    included do
+      # :nocov:
+      def view_component_config
+        @__vc_config ||= self.class.view_component_config.inheritable_copy
+      end
+
+      private
+
+      def inherited(child)
+        child.instance_variable_set(:@__vc_config, nil)
+        super
+      end
+      # :nocov:
+    end
+
+    class_methods do
+      def view_component_config
+        @__vc_config ||= if respond_to?(:superclass) && superclass.respond_to?(:view_component_config)
+          superclass.view_component_config.inheritable_copy
+        else
+          # create a new "anonymous" class that will host the compiled reader methods
+          ViewComponent::ComponentLocalConfig::Configuration.new
+        end
+      end
+
+      def configure_view_component(&block)
+        view_component_config.instance_eval(&block)
+        view_component_config.compile_methods!
+      end
+    end
+  end
+end

data/lib/view_component/config.rb

@@ -21,8 +21,7 @@ module ViewComponent
           show_previews: Rails.env.development? || Rails.env.test?,
           preview_paths: default_preview_paths,
           test_controller: "ApplicationController",
-          default_preview_layout: nil,
-          capture_compatibility_patch_enabled: false
+          default_preview_layout: nil
         })
       end
 
@@ -145,13 +144,6 @@ module ViewComponent
       # previews.
       # Defaults to `nil`. If this is falsy, `"component_preview"` is used.
 
-      # @!attribute capture_compatibility_patch_enabled
-      # @return [Boolean]
-      # Enables the experimental capture compatibility patch that makes ViewComponent
-      # compatible with forms, capture, and other built-ins.
-      # previews.
-      # Defaults to `false`.
-
       def default_preview_paths
         (default_rails_preview_paths + default_rails_engines_preview_paths).uniq
       end

data/lib/view_component/engine.rb

@@ -51,12 +51,6 @@ module ViewComponent
       end
     end
 
-    initializer "view_component.enable_capture_patch" do |app|
-      ActiveSupport.on_load(:view_component) do
-        ActionView::Base.include(ViewComponent::CaptureCompatibility) if app.config.view_component.capture_compatibility_patch_enabled
-      end
-    end
-
     initializer "view_component.set_autoload_paths" do |app|
       options = app.config.view_component
 
@@ -66,6 +60,39 @@ module ViewComponent
       end
     end
 
+    initializer "view_component.propshaft_support" do |_app|
+      ActiveSupport.on_load(:view_component) do
+        if defined?(Propshaft)
+          include Propshaft::Helper
+        end
+      end
+    end
+
+    config.after_initialize do |app|
+      ActiveSupport.on_load(:view_component) do
+        if defined?(Sprockets::Rails)
+          include Sprockets::Rails::Helper
+
+          # Copy relevant config to VC context
+          # See: https://github.com/rails/sprockets-rails/blob/266ec49f3c7c96018dd75f9dc4f9b62fe3f7eecf/lib/sprockets/railtie.rb#L245
+          self.debug_assets = app.config.assets.debug
+          self.digest_assets = app.config.assets.digest
+          self.assets_prefix = app.config.assets.prefix
+          self.assets_precompile = app.config.assets.precompile
+
+          self.assets_environment = app.assets
+          self.assets_manifest = app.assets_manifest
+
+          self.resolve_assets_with = app.config.assets.resolve_with
+
+          self.check_precompiled_asset = app.config.assets.check_precompiled_asset
+          self.unknown_asset_fallback = app.config.assets.unknown_asset_fallback
+          # Expose the app precompiled asset check to the view
+          self.precompiled_asset_checker = ->(logical_path) { app.asset_precompiled? logical_path }
+        end
+      end
+    end
+
     initializer "view_component.eager_load_actions" do
       ActiveSupport.on_load(:after_initialize) do
         ViewComponent::Base.descendants.each(&:__vc_compile) if Rails.application.config.eager_load

data/lib/view_component/slot.rb

@@ -58,15 +58,7 @@ module ViewComponent
           if defined?(@__vc_content_block)
             # render_in is faster than `parent.render`
             @__vc_component_instance.render_in(view_context) do |*args|
-              return @__vc_content_block.call(*args) if @__vc_content_block&.source_location.nil?
-
-              block_context = @__vc_content_block.binding.receiver
-
-              if block_context.class < ActionView::Base
-                block_context.capture(*args, &@__vc_content_block)
-              else
-                @__vc_content_block.call(*args)
-              end
+              @__vc_content_block.call(*args)
             end
           else
             @__vc_component_instance.render_in(view_context)

data/lib/view_component/template.rb

@@ -7,7 +7,7 @@ module ViewComponent
 
     DataWithSource = Struct.new(:format, :identifier, :short_identifier, :type, keyword_init: true)
 
-    attr_reader :details
+    attr_reader :details, :path
 
     delegate :virtual_path, to: :@component
     delegate :format, :variant, to: :@details
@@ -98,8 +98,9 @@ module ViewComponent
       @component.silence_redefinition_of_method(call_method_name)
 
       # rubocop:disable Style/EvalWithLocation
-      @component.class_eval <<~RUBY, @path, @lineno
+      @component.class_eval <<~RUBY, @path, @lineno - 1
         def #{call_method_name}
+          @view_context.instance_variable_set(:@virtual_path, virtual_path)
           #{compiled_source}
         end
       RUBY

data/lib/view_component/translatable.rb

@@ -93,7 +93,7 @@ module ViewComponent
     def translate(key = nil, **options)
       raise ViewComponent::TranslateCalledBeforeRenderError if view_context.nil?
 
-      return super unless __vc_i18n_backend
+      return @view_context.translate(key, **options) unless __vc_i18n_backend
       return key.map { |k| translate(k, **options) } if key.is_a?(Array)
 
       locale = options.delete(:locale) || ::I18n.locale
@@ -110,13 +110,13 @@ module ViewComponent
 
         # Fallback to the global translations
         if translated.is_a? ::I18n::MissingTranslation
-          return super(key, locale: locale, **options)
+          return @view_context.translate(key, locale: locale, **options)
         end
 
         translated = html_safe_translation(translated) if as_html
         translated
       else
-        super(key, locale: locale, **options)
+        @view_context.translate(key, locale: locale, **options)
       end
     end
     alias_method :t, :translate

data/lib/view_component/version.rb

@@ -5,7 +5,7 @@ module ViewComponent
     MAJOR = 4
     MINOR = 0
     PATCH = 0
-    PRE = "alpha1"
+    PRE = "alpha3"
 
     STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 4.0.0.alpha1
+  version: 4.0.0.alpha3
 platform: ruby
 authors:
 - ViewComponent Team
@@ -466,10 +466,10 @@ files:
 - docs/CHANGELOG.md
 - lib/view_component.rb
 - lib/view_component/base.rb
-- lib/view_component/capture_compatibility.rb
 - lib/view_component/collection.rb
 - lib/view_component/compile_cache.rb
 - lib/view_component/compiler.rb
+- lib/view_component/component_local_config.rb
 - lib/view_component/config.rb
 - lib/view_component/configurable.rb
 - lib/view_component/deprecation.rb

data/lib/view_component/capture_compatibility.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module ViewComponent
-  # CaptureCompatibility is a module that patches #capture to fix issues
-  # related to ViewComponent and functionality that relies on `capture`
-  # like forms, capture itself, turbo frames, etc.
-  #
-  # This underlying incompatibility with ViewComponent and capture is
-  # that several features like forms keep a reference to the primary
-  # `ActionView::Base` instance which has its own @output_buffer. When
-  # `#capture` is called on the original `ActionView::Base` instance while
-  # evaluating a block from a ViewComponent the @output_buffer is overridden
-  # in the ActionView::Base instance, and *not* the component. This results
-  # in a double render due to `#capture` implementation details.
-  #
-  # To resolve the issue, we override `#capture` so that we can delegate
-  # the `capture` logic to the ViewComponent that created the block.
-  module CaptureCompatibility
-    def self.included(base)
-      return if base < InstanceMethods
-
-      base.class_eval do
-        alias_method :original_capture, :capture
-      end
-
-      base.prepend(InstanceMethods)
-    end
-
-    module InstanceMethods
-      def capture(*args, &block)
-        # Handle blocks that originate from C code and raise, such as `&:method`
-        return original_capture(*args, &block) if block.source_location.nil?
-
-        block_context = block.binding.receiver
-
-        if block_context != self && block_context.class < ActionView::Base
-          block_context.original_capture(*args, &block)
-        else
-          original_capture(*args, &block)
-        end
-      end
-    end
-  end
-end