view_component 4.20.0 → 4.21.0

data/lib/view_component/config.rb

@@ -1,9 +1,102 @@
 # frozen_string_literal: true
 
-require "view_component/deprecation"
+require "view_component/errors"
 
 module ViewComponent
   class Config
+    # An `ActiveSupport::OrderedOptions` that raises when an option it doesn't
+    # know about is set, rather than silently storing it.
+    class Options < ActiveSupport::OrderedOptions # :nodoc:
+      ROOT_NAMESPACE = "config.view_component"
+
+      def initialize(namespace, allowed_keys, default: nil, renamed: {}, removed: {})
+        super(default)
+        @namespace = namespace
+        @allowed_keys = allowed_keys
+        @renamed = renamed
+        @removed = removed
+        @nested_options = {}
+      end
+
+      def []=(key, value)
+        key = key.to_sym
+
+        if @allowed_keys.include?(key)
+          @nested_options[key] ||= value if value.is_a?(Options)
+          if (nested_options = @nested_options[key])
+            raise TypeError, "#{@namespace}.#{key} must be a Hash" unless value.is_a?(Hash)
+
+            value = nested_options.dup.clear.tap do |options|
+              value.each_pair { |nested_key, nested_value| options[nested_key] = nested_value }
+            end
+          end
+
+          super
+        else
+          raise UnknownConfigOptionError.new(
+            "#{@namespace}.#{key}",
+            renamed_to: @renamed[key] && "#{ROOT_NAMESPACE}.#{@renamed[key]}",
+            removed: @removed.key?(key),
+            hint: @removed[key],
+            valid_options: @allowed_keys
+          )
+        end
+      end
+
+      alias_method :store, :[]=
+
+      def merge!(*others)
+        others.each do |other|
+          {}.merge!(other).each_pair do |key, value|
+            key = key.to_sym
+            value = yield(key, self[key], value) if block_given? && key?(key)
+            self[key] = value
+          end
+        end
+        self
+      end
+
+      alias_method :update, :merge!
+
+      def replace(other)
+        replacement = dup.clear
+        replacement.merge!(other)
+        super(replacement)
+      end
+
+      def transform_keys!(*args, &block)
+        return enum_for(:transform_keys!) if args.empty? && !block
+
+        replace(to_h.transform_keys!(*args, &block))
+      end
+
+      def transform_values!(&block)
+        return enum_for(:transform_values!) unless block
+
+        replace(to_h.transform_values!(&block))
+      end
+    end
+
+    # Options renamed in 4.0, mapped to their new name.
+    RENAMED_OPTIONS = {
+      preview_controller: "previews.controller",
+      preview_route: "previews.route",
+      preview_paths: "previews.paths",
+      show_previews: "previews.enabled",
+      default_preview_layout: "previews.default_layout",
+      component_parent_class: "generate.parent_class",
+      view_component_path: "generate.path"
+    }.freeze
+
+    # Options removed in 4.0, mapped to a hint about what to do instead.
+    REMOVED_OPTIONS = {
+      test_controller: "Use the `vc_test_controller_class` test helper instead.",
+      render_monkey_patch_enabled: nil,
+      use_deprecated_instrumentation_name: "Events always use the `render.view_component` name.",
+      capture_compatibility_patch_enabled: nil,
+      show_previews_source: "Consider using Lookbook instead."
+    }.freeze
+
     class << self
       # `new` without any arguments initializes the default configuration, but
       # it's important to differentiate in case that's no longer the case in
@@ -11,11 +104,16 @@ module ViewComponent
       alias_method :default, :new
 
       def defaults
-        ActiveSupport::OrderedOptions.new.merge!({
-          generate: default_generate_options,
-          previews: default_previews_options,
-          instrumentation_enabled: false
-        })
+        options = Options.new(
+          Options::ROOT_NAMESPACE,
+          %i[generate previews instrumentation_enabled],
+          renamed: RENAMED_OPTIONS,
+          removed: REMOVED_OPTIONS
+        )
+        options.generate = default_generate_options
+        options.previews = default_previews_options
+        options.instrumentation_enabled = false
+        options
       end
 
       # @!attribute generate
@@ -156,14 +254,22 @@ module ViewComponent
       end
 
       def default_generate_options
-        options = ActiveSupport::OrderedOptions.new(false)
+        options = Options.new(
+          "#{Options::ROOT_NAMESPACE}.generate",
+          %i[path preview_path parent_class sidecar stimulus_controller typescript locale distinct_locale_files preview use_component_path_for_rspec_tests],
+          default: false,
+          renamed: {component_parent_class: RENAMED_OPTIONS.fetch(:component_parent_class)}
+        )
         options.preview_path = ""
         options.path = "app/components"
         options
       end
 
       def default_previews_options
-        options = ActiveSupport::OrderedOptions.new
+        options = Options.new(
+          "#{Options::ROOT_NAMESPACE}.previews",
+          %i[controller route enabled default_layout paths]
+        )
         options.controller = "ViewComponentsController"
         options.route = "/rails/view_components"
         options.enabled = defined?(Rails.env) && (Rails.env.development? || Rails.env.test?)

data/lib/view_component/engine.rb

@@ -150,10 +150,9 @@ module ViewComponent
       ActiveSupport.on_load(:action_view) do
         next if ActionView::Base.cache_template_loading
 
-        template_watcher = nil
+        template_watcher = CompileCache.template_watcher(app.config.file_watcher)
 
         app.executor.to_run :before do
-          template_watcher ||= CompileCache.template_watcher(app.config.file_watcher)
           template_watcher.execute_if_updated
         end
       end

data/lib/view_component/errors.rb

@@ -267,4 +267,20 @@ module ViewComponent
       super(MESSAGE.gsub("COMPONENT", component_name.to_s))
     end
   end
+
+  class UnknownConfigOptionError < StandardError
+    def initialize(option, renamed_to: nil, removed: false, hint: nil, valid_options: [])
+      message =
+        if renamed_to
+          "`#{option}` was renamed to `#{renamed_to}` in ViewComponent 4.0."
+        elsif removed
+          "`#{option}` was removed in ViewComponent 4.0."
+        else
+          "`#{option}` isn't a ViewComponent configuration option. " \
+            "Valid options are: #{valid_options.join(", ")}."
+        end
+
+      super([message, hint].compact.join(" "))
+    end
+  end
 end

data/lib/view_component/slot.rb

@@ -12,6 +12,18 @@ module ViewComponent
       @parent = parent
     end
 
+    # @private
+    def __vc_dup(parent)
+      dup.tap do |copy|
+        copy.instance_variable_set(:@parent, parent)
+        copy.remove_instance_variable(:@content) if defined?(@content)
+        if __vc_component_instance?
+          component = @__vc_component_instance
+          copy.__vc_component_instance = component.is_a?(Base) ? component.__vc_dup_for_render : component.dup
+        end
+      end
+    end
+
     def content?
       return true if defined?(@__vc_content) && @__vc_content.present?
       return true if defined?(@__vc_content_set_by_with_content) && @__vc_content_set_by_with_content.present?

data/lib/view_component/slotable.rb

@@ -216,9 +216,9 @@ module ViewComponent
       def __vc_register_default_slots
         registered_slots.each do |slot_name, config|
           default_method_name = :"default_#{slot_name}"
-          config[:default_method] = instance_methods.find { |method_name| method_name == default_method_name }
-
-          registered_slots[slot_name] = config
+          registered_slots[slot_name] = config.merge(
+            default_method: method_defined?(default_method_name) ? default_method_name : nil
+          )
         end
       end
 
@@ -361,6 +361,9 @@ module ViewComponent
 
       # If there is a default method for the slot, call it
       if (default_method = registered_slots[slot_name][:default_method])
+        @__vc_default_slots ||= {}
+        return @__vc_default_slots[slot_name] if @__vc_default_slots.key?(slot_name)
+
         renderable_value = send(default_method)
         slot = Slot.new(self)
 
@@ -370,13 +373,34 @@ module ViewComponent
           slot.__vc_content = renderable_value
         end
 
-        slot
+        @__vc_default_slots[slot_name] = slot
       elsif self.class.registered_slots[slot_name][:collection]
         # If empty slot is a collection, return an empty array
         []
       end
     end
 
+    # @private
+    # Collection spacers need independent slots whose parent is the new copy.
+    def __vc_dup_for_render
+      __vc_check_reused_instance!
+
+      dup.tap do |copy|
+        %i[@__vc_set_slots @__vc_default_slots].each do |variable|
+          next unless instance_variable_defined?(variable)
+
+          slots = instance_variable_get(variable).transform_values do |slot|
+            if slot.is_a?(Array)
+              slot.map { |item| item.__vc_dup(copy) }
+            else
+              slot.__vc_dup(copy)
+            end
+          end
+          copy.instance_variable_set(variable, slots)
+        end
+      end
+    end
+
     def __vc_set_slot(slot_name, slot_definition = nil, *args, **kwargs, &block)
       slot_definition ||= self.class.registered_slots[slot_name]
       slot = Slot.new(self)

data/lib/view_component/template.rb

@@ -35,9 +35,9 @@ module ViewComponent
         :file
       end
 
-      # Load file each time we look up #source in case the file has been modified
+      # Only reuse file contents while eager loading; otherwise reflect edits.
       def source
-        ::File.read(@path)
+        CompileCache.read_file(@path)
       end
 
       private
@@ -137,6 +137,19 @@ module ViewComponent
       end
     end
 
+    class Inherited < InlineCall
+      def initialize(component:, template:)
+        super(component: component, method_name: template.call_method_name, defined_on_self: false)
+        @details = template.details
+        @path = template.path
+        @template = template
+      end
+
+      def compile_to_component
+        @component.define_method(safe_method_name, @component.instance_method(@template.safe_method_name))
+      end
+    end
+
     def compile_to_component
       @component.silence_redefinition_of_method(call_method_name)
 
@@ -184,7 +197,7 @@ module ViewComponent
     end
 
     def safe_method_name
-      "_#{call_method_name}_#{@component.name.underscore.gsub("/", "__")}"
+      "_#{call_method_name}_#{format}_#{@component.name.underscore.gsub("/", "__")}"
     end
 
     def normalized_variant_name

data/lib/view_component/test_helpers.rb

@@ -85,19 +85,21 @@ module ViewComponent
     #
     #   In RSpec, `Preview` is appended to `described_class`.
     def render_preview(name, from: __vc_test_helpers_preview_class, params: {})
-      previews_controller = __vc_test_helpers_build_controller(Rails.application.config.view_component.previews.controller.constantize)
-
-      # From what I can tell, it's not possible to overwrite all request parameters
-      # at once, so we set them individually here.
-      params.each do |k, v|
-        previews_controller.request.params[k] = v
-      end
-
-      previews_controller.request.params[:path] = "#{from.preview_name}/#{name}"
+      @page = nil
+      controller_class = Rails.application.config.view_component.previews.controller.constantize
+      request = ActionDispatch::TestRequest.new(vc_test_request.env.dup)
+      query_parameters = vc_test_request.query_parameters.deep_dup.merge(params.stringify_keys)
+      request.path_parameters = vc_test_request.path_parameters.except(*params.keys.map(&:to_sym)).merge(
+        controller: controller_class.controller_path,
+        action: "previews",
+        path: "#{from.preview_name}/#{name}"
+      )
+      request.set_header("action_dispatch.request.query_parameters", query_parameters)
+      request.set_header(Rack::QUERY_STRING, query_parameters.to_query)
+      previews_controller = __vc_test_helpers_build_controller(controller_class, request: request)
       previews_controller.set_response!(ActionDispatch::Response.new)
-      result = previews_controller.previews
-
-      @rendered_content = result
+      previews_controller.process(:previews)
+      @rendered_content = previews_controller.response.body
 
       Nokogiri::HTML5.fragment(@rendered_content)
     end
@@ -149,11 +151,14 @@ module ViewComponent
     # @param klass [Class<ActionController::Base>] The controller to be used.
     def with_controller_class(klass)
       old_controller = defined?(@vc_test_controller) && @vc_test_controller
+      old_view_context = defined?(@vc_test_view_context) && @vc_test_view_context
 
+      @vc_test_view_context = nil
       @vc_test_controller = __vc_test_helpers_build_controller(klass)
       yield
     ensure
       @vc_test_controller = old_controller
+      @vc_test_view_context = old_view_context
     end
 
     # Set format of the current request
@@ -211,15 +216,21 @@ module ViewComponent
     # @param method [String] The request method to set for the current request.
     # @param protocol [Symbol] The protocol to set for the current request (e.g., `:http` or `:https`).
     def with_request_url(full_path, host: nil, method: nil, protocol: nil)
-      old_request_host = vc_test_request.host
+      old_request_host = vc_test_request.get_header("HTTP_HOST")
       old_request_method = vc_test_request.request_method
       old_request_path_info = vc_test_request.path_info
       old_request_path_parameters = vc_test_request.path_parameters
       old_request_query_parameters = vc_test_request.query_parameters
       old_request_query_string = vc_test_request.query_string
+      old_request_fullpath = vc_test_request.fullpath
+      old_request_original_fullpath = vc_test_request.original_fullpath
       old_request_format = vc_test_request.format.symbol
       old_request_scheme = vc_test_request.scheme
+      old_request_protocol = vc_test_request.instance_variable_get(:@protocol)
+      old_request_port = vc_test_request.instance_variable_get(:@port)
       old_controller = defined?(@vc_test_controller) && @vc_test_controller
+      old_controller_params = old_controller.params if old_controller
+      old_controller_url_options = old_controller.instance_variable_get(:@_url_options) if old_controller
 
       path, query = full_path.split("?", 2)
       vc_test_request.instance_variable_set(:@fullpath, full_path)
@@ -227,21 +238,32 @@ module ViewComponent
       vc_test_request.host = host if host
       vc_test_request.request_method = method if method
       vc_test_request.set_header(Rack::RACK_URL_SCHEME, protocol.to_s) if protocol
+      vc_test_request.instance_variable_set(:@protocol, nil)
+      vc_test_request.instance_variable_set(:@port, nil)
       vc_test_request.path_info = path
       vc_test_request.path_parameters = Rails.application.routes.recognize_path_with_request(vc_test_request, path, {})
       vc_test_request.set_header("action_dispatch.request.query_parameters",
         Rack::Utils.parse_nested_query(query).with_indifferent_access)
       vc_test_request.set_header(Rack::QUERY_STRING, query)
+      old_controller.params = nil if old_controller
+      old_controller&.instance_variable_set(:@_url_options, nil)
       yield
     ensure
-      vc_test_request.host = old_request_host
+      vc_test_request.set_header("HTTP_HOST", old_request_host)
       vc_test_request.request_method = old_request_method
       vc_test_request.set_header(Rack::RACK_URL_SCHEME, old_request_scheme)
+      vc_test_request.instance_variable_set(:@protocol, old_request_protocol)
+      vc_test_request.instance_variable_set(:@port, old_request_port)
       vc_test_request.path_info = old_request_path_info
       vc_test_request.path_parameters = old_request_path_parameters
       vc_test_request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)
       vc_test_request.set_header(Rack::QUERY_STRING, old_request_query_string)
+      vc_test_request.instance_variable_set(:@fullpath, old_request_fullpath)
+      vc_test_request.instance_variable_set(:@original_fullpath, old_request_original_fullpath)
       vc_test_request.format = old_request_format
+      old_controller.params = old_controller_params if old_controller
+      @vc_test_controller&.instance_variable_set(:@_url_options, nil)
+      old_controller&.instance_variable_set(:@_url_options, old_controller_url_options)
       @vc_test_controller = old_controller
     end
 
@@ -298,8 +320,8 @@ module ViewComponent
     # Note: We prefix private methods here to prevent collisions in consumer's tests.
     private
 
-    def __vc_test_helpers_build_controller(klass)
-      klass.new.tap { |c| c.request = vc_test_request }.extend(Rails.application.routes.url_helpers)
+    def __vc_test_helpers_build_controller(klass, request: vc_test_request)
+      klass.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
     end
 
     def __vc_test_helpers_preview_class

data/lib/view_component/translatable.rb

@@ -14,6 +14,34 @@ module ViewComponent
     TRANSLATION_EXTENSIONS = %w[yml yaml].freeze
     private_constant :TRANSLATION_EXTENSIONS
 
+    # Like Rails' translation helper, use a sentinel that survives cache serialization.
+    MISSING_TRANSLATION = -(2**61)
+    private_constant :MISSING_TRANSLATION
+
+    def self.symbolic_defaults?(options)
+      default = options[:default]
+      default.is_a?(Symbol) || (default.is_a?(Array) && default.any? { |value| value.is_a?(Symbol) })
+    end
+
+    def self.translate_with_defaults(translator, key, options)
+      defaults = options[:default].is_a?(Array) ? options[:default].compact : [options[:default]]
+      options = options.except(:default)
+
+      translated = translator.translate(key, **options, default: MISSING_TRANSLATION)
+      return translated unless translated == MISSING_TRANSLATION
+
+      defaults.each do |default|
+        translated = if default.is_a?(Symbol)
+          translator.translate(default, **options, default: MISSING_TRANSLATION)
+        else
+          translator.translate(key, **options, default: [default, MISSING_TRANSLATION])
+        end
+        return translated unless translated == MISSING_TRANSLATION
+      end
+
+      translator.translate(key, **options)
+    end
+
     included do
       class_attribute :__vc_i18n_backend, instance_writer: false, instance_predicate: false
     end
@@ -53,9 +81,13 @@ module ViewComponent
 
       def translate(key = nil, **options)
         return key.map { |k| translate(k, **options) } if key.is_a?(Array)
+        symbolic_defaults = Translatable.symbolic_defaults?(options)
+        return ::I18n.translate(key, **options) if key.nil? && !symbolic_defaults
 
         __vc_ensure_compiled
 
+        return Translatable.translate_with_defaults(self, key, options) if symbolic_defaults
+
         locale = options.delete(:locale) || ::I18n.locale
         key = __vc_i18n_key(key, options.delete(:scope))
 
@@ -99,6 +131,8 @@ module ViewComponent
 
       return @view_context.translate(key, **options) unless __vc_i18n_backend
       return key.map { |k| translate(k, **options) } if key.is_a?(Array)
+      return Translatable.translate_with_defaults(self, key, options) if Translatable.symbolic_defaults?(options)
+      return @view_context.translate(key, **options) if key.nil?
 
       locale = options.delete(:locale) || ::I18n.locale
       key = self.class.__vc_i18n_key(key, options.delete(:scope))

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 4
-    MINOR = 20
+    MINOR = 21
     PATCH = 0
     PRE = nil
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 4.20.0
+  version: 4.21.0
 platform: ruby
 authors:
 - ViewComponent Team