view_component 4.12.0 → 4.15.0

data/lib/view_component/serializable/proxy.rb

@@ -0,0 +1,110 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Serializable
+    # A proxy that wraps a component class and its initialization arguments, deferring
+    # component instantiation until render time. This allows slot calls and other
+    # post-initialize configuration to be captured and replayed, and enables the
+    # proxy itself (rather than a live component instance) to be serialized for
+    # background jobs (e.g. ActiveJob / Turbo Streams).
+    class Proxy
+      # Rebuilds a Proxy from a serialized hash produced by +serialize+
+      def self.deserialize(hash)
+        klass = hash["component_class"].safe_constantize
+        raise ArgumentError, "Cannot deserialize unknown component: #{hash["component_class"]}" unless klass
+
+        args = ActiveJob::Arguments.deserialize(hash["initialize_args"] || [])
+        proxy = new(klass, *args)
+
+        Array(hash["slot_calls"]).each do |call|
+          method_name = call["method"].to_sym
+          slot_args = ActiveJob::Arguments.deserialize(call["args"])
+          proxy.public_send(method_name, *slot_args)
+        end
+
+        proxy
+      end
+
+      attr_reader :component_class, :initialize_args, :slot_calls
+
+      def initialize(component_class, *args)
+        if component_class.name.nil?
+          raise UnserializableError, "Cannot serialize anonymous component class #{component_class.inspect}"
+        end
+
+        @component_class = component_class
+        @initialize_args = args
+        @slot_calls = []
+      end
+      ruby2_keywords :initialize
+
+      # Implements the Rails renderable interface
+      def render_in(view_context, &block)
+        if block
+          raise UnserializableError, "Cannot serialize render_in with a block"
+        end
+        build_component.render_in(view_context)
+      end
+
+      def method_missing(method_name, *args, &block)
+        if slot_method?(method_name)
+          capture_slot_call(method_name, args, &block)
+        else
+          super
+        end
+      end
+      ruby2_keywords :method_missing
+
+      def respond_to_missing?(method_name, include_private = false)
+        slot_method?(method_name) || super
+      end
+
+      # Returns a hash that can be rebuilt into a Proxy instance using +deserialize+
+      def serialize
+        serialized_slot_calls = @slot_calls.map do |call|
+          {
+            "method" => call[:method].to_s,
+            "args" => ActiveJob::Arguments.serialize(call[:args])
+          }
+        end
+
+        {
+          "component_class" => @component_class.name,
+          "initialize_args" => ActiveJob::Arguments.serialize(@initialize_args),
+          "slot_calls" => serialized_slot_calls
+        }
+      end
+
+      if defined?(Rails::VERSION) && Rails::VERSION::MAJOR == 7 && Rails::VERSION::MINOR == 1
+        # Rails expects us to define `format` on all renderables,
+        # but we do not know the `format` of a ViewComponent until runtime.
+        def format
+          nil
+        end
+      end
+
+      private
+
+      def slot_method?(method_name)
+        method_name.to_s.start_with?("with_") && @component_class.method_defined?(method_name)
+      end
+
+      def capture_slot_call(method_name, args, &block)
+        if block
+          raise UnserializableError, "Cannot serialize slot call '#{method_name}' with a block"
+        end
+
+        @slot_calls << {method: method_name, args: args}
+        self
+      end
+
+      def build_component
+        @component_class.new(*@initialize_args).tap do |instance|
+          @slot_calls.each do |call|
+            instance.public_send(call[:method], *call[:args])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/view_component/serializable.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+require "view_component/serializable/proxy"
+
+module ViewComponent
+  module Serializable
+    extend ActiveSupport::Concern
+
+    class UnserializableError < ArgumentError; end
+
+    class_methods do
+      # Returns a Proxy that captures this class and its initialization arguments,
+      # deferring instantiation until render time. The proxy is renderable and
+      # serializable for ActiveJob (e.g. Turbo Streams). Slot calls made on the
+      # proxy are captured and replayed at render time. Blocks are not supported.
+      #
+      #   MyComponent.render_later("title", size: :large).with_item(label: "One")
+      def render_later(*args, &block)
+        raise UnserializableError, "Cannot serialize render_later with a block" if block
+
+        ViewComponent::Serializable::Proxy.new(self, *args)
+      end
+      ruby2_keywords :render_later
+    end
+  end
+end

data/lib/view_component/template.rb

@@ -5,7 +5,7 @@ module ViewComponent
     DEFAULT_FORMAT = :html
     private_constant :DEFAULT_FORMAT
 
-    DataWithSource = Struct.new(:format, :identifier, :short_identifier, :type, keyword_init: true)
+    DataWithSource = Struct.new(:format, :identifier, :short_identifier, :type)
 
     attr_reader :details, :path
 
@@ -28,33 +28,7 @@ module ViewComponent
           details = ActionView::TemplateDetails.new(details.locale, details.handler, DEFAULT_FORMAT, details.variant)
         end
 
-        @strip_annotation_line = false
-
-        # Rails 8.1 added a newline to compiled ERB output (rails/rails#53731).
-        # Use -1 to compensate for correct line numbers in stack traces.
-        # However, negative line numbers cause segfaults when Ruby's coverage
-        # is enabled (bugs.ruby-lang.org/issues/19363). In that case, strip the
-        # annotation line from compiled source instead.
-        lineno =
-          if Rails::VERSION::MAJOR >= 8 && Rails::VERSION::MINOR > 0 && details.handler == :erb
-            if coverage_running?
-              # Can't use negative lineno with coverage (causes segfault on Linux).
-              # Strip annotation line if enabled to preserve correct line numbers.
-              @strip_annotation_line = ActionView::Base.annotate_rendered_view_with_filenames
-              0
-            else
-              -1
-            end
-          else
-            0
-          end
-
-        super(
-          component: component,
-          details: details,
-          path: path,
-          lineno: lineno
-        )
+        super
       end
 
       def type
@@ -68,11 +42,36 @@ module ViewComponent
 
       private
 
+      # Rails 8.1 added a newline to compiled ERB output (rails/rails#53731).
+      # Use -1 to compensate for correct line numbers in stack traces.
+      # However, negative line numbers cause segfaults when Ruby's coverage
+      # is enabled (bugs.ruby-lang.org/issues/19363). In that case, strip the
+      # annotation line from compiled source instead.
+      #
+      # Computed at compile time rather than at initialization because both
+      # coverage and annotation settings can change between the two.
+      def lineno
+        return 0 unless erb_newline_compensation_needed?
+
+        # Can't use negative lineno with coverage (causes segfault on Linux).
+        coverage_running? ? 0 : -1
+      end
+
+      # Strip the annotation line to maintain correct line numbers when coverage
+      # is running (avoids segfault from negative lineno)
+      def strip_annotation_line?
+        erb_newline_compensation_needed? &&
+          coverage_running? &&
+          ActionView::Base.annotate_rendered_view_with_filenames
+      end
+
+      def erb_newline_compensation_needed?
+        Rails::VERSION::MAJOR >= 8 && Rails::VERSION::MINOR > 0 && details.handler == :erb
+      end
+
       def compiled_source
         result = super
-        # Strip the annotation line to maintain correct line numbers when coverage
-        # is running (avoids segfault from negative lineno)
-        result = result.partition(";").last if @strip_annotation_line
+        result = result.partition(";").last if strip_annotation_line?
         result
       end
     end
@@ -147,7 +146,7 @@ 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
         def #{call_method_name}
           #{compiled_source}
         end
@@ -195,6 +194,8 @@ module ViewComponent
 
     private
 
+    attr_reader :lineno
+
     def compiled_source
       handler = details.handler_class
       this_source = source

data/lib/view_component/version.rb

@@ -3,12 +3,10 @@
 module ViewComponent
   module VERSION
     MAJOR = 4
-    MINOR = 12
+    MINOR = 15
     PATCH = 0
     PRE = nil
 
-    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".").freeze
   end
 end
-
-puts ViewComponent::VERSION::STRING if __FILE__ == $PROGRAM_NAME

data/lib/view_component.rb

@@ -8,13 +8,16 @@ module ViewComponent
   extend ActiveSupport::Autoload
 
   autoload :Base
+  autoload :CacheDigest
   autoload :Compiler
   autoload :CompileCache
   autoload :Config
   autoload :Deprecation
+  autoload :ExperimentallyCacheable
   autoload :InlineTemplate
   autoload :Instrumentation
   autoload :Preview
+  autoload :Serializable
   autoload :Translatable
 
   if defined?(Rails.env) && Rails.env.test?

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 4.12.0
+  version: 4.15.0
 platform: ruby
 authors:
 - ViewComponent Team
@@ -89,7 +89,11 @@ files:
 - lib/generators/view_component/test_unit/templates/component_test.rb.tt
 - lib/generators/view_component/test_unit/test_unit_generator.rb
 - lib/view_component.rb
+- lib/view_component/active_job_serializer.rb
 - lib/view_component/base.rb
+- lib/view_component/cache_digest.rb
+- lib/view_component/cache_digest/dependency_tracking.rb
+- lib/view_component/cache_digest/resolver.rb
 - lib/view_component/collection.rb
 - lib/view_component/compile_cache.rb
 - lib/view_component/compiler.rb
@@ -98,10 +102,13 @@ files:
 - lib/view_component/deprecation.rb
 - lib/view_component/engine.rb
 - lib/view_component/errors.rb
+- lib/view_component/experimentally_cacheable.rb
 - lib/view_component/inline_template.rb
 - lib/view_component/instrumentation.rb
 - lib/view_component/preview.rb
 - lib/view_component/request_details.rb
+- lib/view_component/serializable.rb
+- lib/view_component/serializable/proxy.rb
 - lib/view_component/slot.rb
 - lib/view_component/slotable.rb
 - lib/view_component/system_spec_helpers.rb
@@ -135,7 +142,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 4.0.10
+rubygems_version: 4.0.16
 specification_version: 4
 summary: A framework for building reusable, testable & encapsulated view components
   in Ruby on Rails.