view_component 3.5.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ce590ddce7011ae4362dde0733f78ba65992c31add6bac215555515d02ae1dc6
-  data.tar.gz: df4867599a61d2757e2f226a3c6b187981772e2d225fc442f9184484c0423e64
+  metadata.gz: d3f4f53b04ea58ed971bef33e1bea8ab65c2564c64a49927ca5db90c118d23bc
+  data.tar.gz: 1a6b6024ffd5baf72cb80726b0853cf3fcab80d43505c87648cc57d6726e9185
 SHA512:
-  metadata.gz: 0a39d71f089c0f4285dc1eecd324e44afc73f55565002a45c2d37292cc4fa8b05713f7237f04b530617ddc0bb2ccd08fab0c7d010400790dc00daf2d6c9c0546
-  data.tar.gz: 252a63a4ed7eefd7db529dc93081d3ccfb78555ac1d051540f7a69829a41d4d22fd94557fa2fe9eb88c012bd8dccfd2ceb813aae2582877e387a2df347e2d915
+  metadata.gz: 0f75de114591fca8e662e6fa15086c0b6b11c5862a05e68abff123ba19b7b23b7f67e7b65f8adca8a78688011254117643e9f0e76b92e5a0c0c51d82ecb85194
+  data.tar.gz: 9771fc3c30b8472bb2f0793573926cd7b05e8f991091af18f8e51cfd5370ea8ac7f1eff40488eb0e1434a81683e901fcd74659763620f2e5ae8a26d4db0c943b

data/app/helpers/preview_helper.rb

@@ -1,6 +1,10 @@
 # frozen_string_literal: true
 
 module PreviewHelper
+  # :nocov:
+  include ActionView::Helpers::AssetUrlHelper if Rails.version.to_f < 6.1
+  # :nocov:
+
   AVAILABLE_PRISM_LANGUAGES = %w[ruby erb haml]
   FALLBACK_LANGUAGE = "ruby"
 
@@ -10,6 +14,14 @@ module PreviewHelper
     render "preview_source"
   end
 
+  def prism_css_source_url
+    serve_static_preview_assets? ? asset_path("prism.css", skip_pipeline: true) : "https://cdn.jsdelivr.net/npm/prismjs@1.28.0/themes/prism.min.css"
+  end
+
+  def prism_js_source_url
+    serve_static_preview_assets? ? asset_path("prism.min.js", skip_pipeline: true) : "https://cdn.jsdelivr.net/npm/prismjs@1.28.0/prism.min.js"
+  end
+
   def find_template_data(lookup_context:, template_identifier:)
     template = lookup_context.find_template(template_identifier)
 
@@ -18,6 +30,7 @@ module PreviewHelper
         source: template.source,
         prism_language_name: prism_language_name_by_template(template: template)
       }
+    # :nocov:
     else
       # Fetch template source via finding it through preview paths
       # to accomodate source view when exclusively using templates
@@ -43,6 +56,7 @@ module PreviewHelper
         prism_language_name: prism_language_name
       }
     end
+    # :nocov:
   end
 
   private
@@ -55,6 +69,7 @@ module PreviewHelper
     language
   end
 
+  # :nocov:
   def prism_language_name_by_template_path(template_file_path:)
     language = template_file_path.gsub(".html", "").split(".").last
 
@@ -62,4 +77,9 @@ module PreviewHelper
 
     language
   end
+  # :nocov:
+
+  def serve_static_preview_assets?
+    ViewComponent::Base.config.show_previews && Rails.application.config.public_file_server.enabled
+  end
 end

data/app/views/view_components/_preview_source.html.erb

@@ -1,4 +1,4 @@
-<link href="<%= asset_path('prism.css', skip_pipeline: true) %>" media="screen" rel="stylesheet" type="text/css">
+<link href="<%= prism_css_source_url %>" media="screen" rel="stylesheet" type="text/css">
 <div class="view-component-source-example">
   <h2>Source:</h2>
   <pre class="source">
@@ -14,4 +14,4 @@
     <% end %>
   </pre>
 </div>
-<script type="text/javascript" src="<%= asset_path('prism.min.js', skip_pipeline: true) %>"></script>
+<script type="text/javascript" src="<%= prism_js_source_url %>"></script>

data/docs/CHANGELOG.md

@@ -10,6 +10,171 @@ nav_order: 5
 
 ## main
 
+## 3.10.0
+
+* Fix html escaping in `#call` for non-strings.
+
+    *Reegan Viljoen, Cameron Dutro*
+
+* Add `output_preamble` to match `output_postamble`, using the same safety checks.
+
+    *Kali Donovan, Michael Daross*
+
+* Exclude html escaping of I18n reserved keys with `I18n::RESERVED_KEYS` rather than `I18n.reserved_keys_pattern`.
+
+    *Nick Coyne*
+
+* Update CI configuration to use `Appraisal`.
+
+    *Hans Lemuet, Simon Fish*
+
+## 3.9.0
+
+* Don’t break `rails stats` if ViewComponent path is missing.
+
+    *Claudio Baccigalupo*
+
+* Add deprecation warnings for EOL ruby and Rails versions and patches associated with them.
+
+    *Reegan Viljoen*
+
+* Add support for Ruby 3.3.
+
+    *Reegan Viljoen*
+
+* Allow translations to be inherited and overridden in subclasses.
+
+    *Elia Schito*
+
+* Resolve console warnings when running test suite.
+
+    *Joel Hawksley*
+
+* Fix spelling in a local variable.
+
+    *Olle Jonsson*
+
+* Avoid duplicating rendered string when `output_postamble` is blank.
+
+    *Mitchell Henke*
+
+* Ensure HTML output safety.
+
+    *Cameron Dutro*
+
+## 3.8.0
+
+* Use correct value for the `config.action_dispatch.show_exceptions` config option for edge Rails.
+
+    *Cameron Dutro*
+
+* Remove unsupported versions of Rails & Ruby from CI matrix.
+
+    *Reegan Viljoen*
+
+* Raise error when uncountable slot names are used in `renders_many`
+
+    *Hugo Chantelauze*
+    *Reegan Viljoen*
+
+* Replace usage of `String#ends_with?` with `String#end_with?` to reduce the dependency on ActiveSupport core extensions.
+
+    *halo*
+
+* Don't add ActionDispatch::Static middleware unless `public_file_server.enabled`.
+
+    *Daniel Gonzalez*
+    *Reegan Viljoen*
+
+* Resolve an issue where slots starting with `call` would cause a `NameError`
+
+    *Blake Williams*
+
+* Add `use_helper` API.
+
+    *Reegan Viljoen*
+
+* Fix bug where the `Rails` module wasn't being searched from the root namespace.
+
+    *Zenéixe*
+
+* Fix bug where `#with_request_url`, set the incorrect `request.fullpath`.
+
+    *Nachiket Pusalkar*
+
+* Allow setting method when using the `with_request_url` test helper.
+
+    *Andrew Duthie*
+
+## 3.7.0
+
+* Support Rails 7.1 in CI.
+
+    *Reegan Viljoen*
+    *Cameron Dutro*
+
+* Document the capture compatibility patch on the Known issues page.
+
+    *Simon Fish*
+
+* Add Simundia to list of companies using ViewComponent.
+
+    *Alexandre Ignjatovic*
+
+* Reduce UnboundMethod objects by memoizing initialize_parameters.
+
+    *Rainer Borene*
+
+* Improve docs about inline templates interpolation.
+
+    *Hans Lemuet*
+
+* Update generators.md to clarify the way of changing `config.view_component.view_component_path`.
+
+    *Shozo Hatta*
+
+* Attempt to fix Ferrum timeout errors by creating driver with unique name.
+
+    *Cameron Dutro*
+
+## 3.6.0
+
+* Refer to `helpers` in `NameError` message in development and test environments.
+
+    *Simon Fish*
+
+* Fix API documentation and revert unnecessary change in `preview.rb`.
+
+    *Richard Macklin*
+
+* Initialize ViewComponent::Config with defaults before framework load.
+
+    *Simon Fish*
+
+* Add 3.2 to the list of Ruby CI versions
+
+    *Igor Drozdov*
+
+* Stop running PVC's `docs:preview` rake task in CI, as the old docsite has been removed.
+
+    *Cameron Dutro*
+
+* Minor testing documentation improvement.
+
+    *Travis Gaff*
+
+* Add SearchApi to users list.
+
+    *Sebastjan Prachovskij*
+
+* Fix `#with_request_url` to ensure `request.query_parameters` is an instance of ActiveSupport::HashWithIndifferentAccess.
+
+    *milk1000cc*
+
+* Add PeopleForce to list of companies using ViewComponent.
+
+    *Volodymyr Khandiuk*
+
 ## 3.5.0
 
 * Add Skroutz to users list.
@@ -112,6 +277,17 @@ This release makes the following breaking changes, many of which have long been
 
     *Joel Hawksley*
 
+For example:
+
+```diff
+<%= render BlogComponent.new do |component| %>
+-  <% component.header do %>
++  <% component.with_header do %>
+    <%= link_to "My blog", root_path %>
+  <% end %>
+<% end %>
+```
+
 * BREAKING: Remove deprecated SlotsV1 in favor of current SlotsV2.
 
     *Joel Hawksley*

data/lib/rails/generators/locale/component_generator.rb

@@ -34,11 +34,11 @@ module Locale
       end
 
       def destination(locale = nil)
-        extention = ".#{locale}" if locale
+        extension = ".#{locale}" if locale
         if sidecar?
-          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component#{extention}.yml")
+          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component#{extension}.yml")
         else
-          File.join(component_path, class_path, "#{file_name}_component#{extention}.yml")
+          File.join(component_path, class_path, "#{file_name}_component#{extension}.yml")
         end
       end
     end

data/lib/view_component/base.rb

@@ -12,6 +12,7 @@ require "view_component/preview"
 require "view_component/slotable"
 require "view_component/translatable"
 require "view_component/with_content_helper"
+require "view_component/use_helpers"
 
 module ViewComponent
   class Base < ActionView::Base
@@ -22,12 +23,8 @@ module ViewComponent
       #
       # @return [ActiveSupport::OrderedOptions]
       def config
-        @config ||= ActiveSupport::OrderedOptions.new
+        ViewComponent::Config.current
       end
-
-      # Replaces the entire config. You shouldn't need to use this directly
-      # unless you're building a `ViewComponent::Config` elsewhere.
-      attr_writer :config
     end
 
     include ViewComponent::InlineTemplate
@@ -107,7 +104,14 @@ module ViewComponent
       before_render
 
       if render?
-        render_template_for(@__vc_variant).to_s + output_postamble
+        # Avoid allocating new string when output_preamble and output_postamble are blank
+        rendered_template = safe_render_template_for(@__vc_variant).to_s
+
+        if output_preamble.blank? && output_postamble.blank?
+          rendered_template
+        else
+          safe_output_preamble + rendered_template + safe_output_postamble
+        end
       else
         ""
       end
@@ -154,11 +158,18 @@ module ViewComponent
       end
     end
 
+    # Optional content to be returned before the rendered template.
+    #
+    # @return [String]
+    def output_preamble
+      @@default_output_preamble ||= "".html_safe
+    end
+
     # Optional content to be returned after the rendered template.
     #
     # @return [String]
     def output_postamble
-      ""
+      @@default_output_postamble ||= "".html_safe
     end
 
     # Called before rendering the component. Override to perform operations that
@@ -223,6 +234,22 @@ module ViewComponent
       @__vc_helpers ||= __vc_original_view_context || controller.view_context
     end
 
+    if ::Rails.env.development? || ::Rails.env.test?
+      # @private
+      def method_missing(method_name, *args) # rubocop:disable Style/MissingRespondToMissing
+        super
+      rescue => e # rubocop:disable Style/RescueStandardError
+        e.set_backtrace e.backtrace.tap(&:shift)
+        raise e, <<~MESSAGE.chomp if view_context && e.is_a?(NameError) && helpers.respond_to?(method_name)
+          #{e.message}
+
+          You may be trying to call a method provided as a view helper. Did you mean `helpers.#{method_name}'?
+        MESSAGE
+
+        raise
+      end
+    end
+
     # Exposes .virtual_path as an instance method
     #
     # @private
@@ -289,6 +316,44 @@ module ViewComponent
       defined?(@__vc_content_evaluated) && @__vc_content_evaluated
     end
 
+    def maybe_escape_html(text)
+      return text if request && !request.format.html?
+      return text if text.blank?
+
+      if text.html_safe?
+        text
+      else
+        yield
+        html_escape(text)
+      end
+    end
+
+    def safe_render_template_for(variant)
+      if compiler.renders_template_for_variant?(variant)
+        render_template_for(variant)
+      else
+        maybe_escape_html(render_template_for(variant)) do
+          Kernel.warn("WARNING: The #{self.class} component rendered HTML-unsafe output. The output will be automatically escaped, but you may want to investigate.")
+        end
+      end
+    end
+
+    def safe_output_preamble
+      maybe_escape_html(output_preamble) do
+        Kernel.warn("WARNING: The #{self.class} component was provided an HTML-unsafe preamble. The preamble will be automatically escaped, but you may want to investigate.")
+      end
+    end
+
+    def safe_output_postamble
+      maybe_escape_html(output_postamble) do
+        Kernel.warn("WARNING: The #{self.class} component was provided an HTML-unsafe postamble. The postamble will be automatically escaped, but you may want to investigate.")
+      end
+    end
+
+    def compiler
+      @compiler ||= self.class.compiler
+    end
+
     # Set the controller used for testing components:
     #
     # ```ruby
@@ -542,6 +607,7 @@ module ViewComponent
       # @param parameter [Symbol] The parameter name used when rendering elements of a collection.
       def with_collection_parameter(parameter)
         @provided_collection_parameter = parameter
+        @initialize_parameters = nil
       end
 
       # Strips trailing whitespace from templates before compiling them.
@@ -603,7 +669,7 @@ module ViewComponent
 
       # @private
       def collection_counter_parameter
-        "#{collection_parameter}_counter".to_sym
+        :"#{collection_parameter}_counter"
       end
 
       # @private
@@ -613,7 +679,7 @@ module ViewComponent
 
       # @private
       def collection_iteration_parameter
-        "#{collection_parameter}_iteration".to_sym
+        :"#{collection_parameter}_iteration"
       end
 
       # @private
@@ -637,7 +703,7 @@ module ViewComponent
       end
 
       def initialize_parameters
-        instance_method(:initialize).parameters
+        @initialize_parameters ||= instance_method(:initialize).parameters
       end
 
       def provided_collection_parameter

data/lib/view_component/compiler.rb

@@ -16,6 +16,7 @@ module ViewComponent
     def initialize(component_class)
       @component_class = component_class
       @redefinition_lock = Mutex.new
+      @variants_rendering_templates = Set.new
     end
 
     def compiled?
@@ -56,7 +57,7 @@ module ViewComponent
           RUBY
           # rubocop:enable Style/EvalWithLocation
 
-          component_class.define_method("_call_#{safe_class_name}", component_class.instance_method(:call))
+          component_class.define_method(:"_call_#{safe_class_name}", component_class.instance_method(:call))
 
           component_class.silence_redefinition_of_method("render_template_for")
           component_class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
@@ -68,6 +69,7 @@ module ViewComponent
       else
         templates.each do |template|
           method_name = call_method_name(template[:variant])
+          @variants_rendering_templates << template[:variant]
 
           redefinition_lock.synchronize do
             component_class.silence_redefinition_of_method(method_name)
@@ -89,6 +91,10 @@ module ViewComponent
       CompileCache.register(component_class)
     end
 
+    def renders_template_for_variant?(variant)
+      @variants_rendering_templates.include?(variant)
+    end
+
     private
 
     attr_reader :component_class, :redefinition_lock
@@ -101,7 +107,7 @@ module ViewComponent
         "elsif variant.to_sym == :'#{variant}'\n    #{safe_name}"
       end.join("\n")
 
-      component_class.define_method("_call_#{safe_class_name}", component_class.instance_method(:call))
+      component_class.define_method(:"_call_#{safe_class_name}", component_class.instance_method(:call))
 
       body = <<-RUBY
         if variant.nil?
@@ -219,12 +225,12 @@ module ViewComponent
               component_class.included_modules
             )
 
-          view_component_ancestors.flat_map { |ancestor| ancestor.instance_methods(false).grep(/^call/) }.uniq
+          view_component_ancestors.flat_map { |ancestor| ancestor.instance_methods(false).grep(/^call(_|$)/) }.uniq
         end
     end
 
     def inline_calls_defined_on_self
-      @inline_calls_defined_on_self ||= component_class.instance_methods(false).grep(/^call/)
+      @inline_calls_defined_on_self ||= component_class.instance_methods(false).grep(/^call(_|$)/)
     end
 
     def variants
@@ -258,6 +264,7 @@ module ViewComponent
 
       if handler.method(:call).parameters.length > 1
         handler.call(component_class, template)
+      # :nocov:
       else
         handler.call(
           OpenStruct.new(
@@ -267,6 +274,7 @@ module ViewComponent
           )
         )
       end
+      # :nocov:
     end
 
     def call_method_name(variant)

data/lib/view_component/config.rb

@@ -167,6 +167,14 @@ module ViewComponent
       end
     end
 
+    # @!attribute current
+    # @return [ViewComponent::Config]
+    # Returns the current ViewComponent::Config. This is persisted against this
+    # class so that config options remain accessible before the rest of
+    # ViewComponent has loaded. Defaults to an instance of ViewComponent::Config
+    # with all other documented defaults set.
+    class_attribute :current, default: defaults, instance_predicate: false
+
     def initialize
       @config = self.class.defaults
     end

data/lib/view_component/engine.rb

@@ -6,7 +6,7 @@ require "view_component/deprecation"
 
 module ViewComponent
   class Engine < Rails::Engine # :nodoc:
-    config.view_component = ViewComponent::Config.defaults
+    config.view_component = ViewComponent::Config.current
 
     rake_tasks do
       load "view_component/rails/tasks/view_component.rake"
@@ -15,6 +15,9 @@ module ViewComponent
     initializer "view_component.set_configs" do |app|
       options = app.config.view_component
 
+      %i[generate preview_controller preview_route show_previews_source].each do |config_option|
+        options[config_option] ||= ViewComponent::Base.public_send(config_option)
+      end
       options.instrumentation_enabled = false if options.instrumentation_enabled.nil?
       options.render_monkey_patch_enabled = true if options.render_monkey_patch_enabled.nil?
       options.show_previews = (Rails.env.development? || Rails.env.test?) if options.show_previews.nil?
@@ -37,8 +40,6 @@ module ViewComponent
 
     initializer "view_component.enable_instrumentation" do |app|
       ActiveSupport.on_load(:view_component) do
-        Base.config = app.config.view_component
-
         if app.config.view_component.instrumentation_enabled.present?
           # :nocov: Re-executing the below in tests duplicates initializers and causes order-dependent failures.
           ViewComponent::Base.prepend(ViewComponent::Instrumentation)
@@ -79,6 +80,9 @@ module ViewComponent
     initializer "view_component.monkey_patch_render" do |app|
       next if Rails.version.to_f >= 6.1 || !app.config.view_component.render_monkey_patch_enabled
 
+      # :nocov:
+      ViewComponent::Deprecation.deprecation_warning("Monkey patching `render`", "ViewComponent 4.0 will remove the `render` monkey patch")
+
       ActiveSupport.on_load(:action_view) do
         require "view_component/render_monkey_patch"
         ActionView::Base.prepend ViewComponent::RenderMonkeyPatch
@@ -90,11 +94,15 @@ module ViewComponent
         ActionController::Base.prepend ViewComponent::RenderingMonkeyPatch
         ActionController::Base.prepend ViewComponent::RenderToStringMonkeyPatch
       end
+      # :nocov:
     end
 
     initializer "view_component.include_render_component" do |_app|
       next if Rails.version.to_f >= 6.1
 
+      # :nocov:
+      ViewComponent::Deprecation.deprecation_warning("using `render_component`", "ViewComponent 4.0 will remove `render_component`")
+
       ActiveSupport.on_load(:action_view) do
         require "view_component/render_component_helper"
         ActionView::Base.include ViewComponent::RenderComponentHelper
@@ -106,14 +114,19 @@ module ViewComponent
         ActionController::Base.include ViewComponent::RenderingComponentHelper
         ActionController::Base.include ViewComponent::RenderComponentToStringHelper
       end
+      # :nocov:
     end
 
     initializer "static assets" do |app|
-      if app.config.view_component.show_previews
+      if serve_static_preview_assets?(app.config)
         app.middleware.use(::ActionDispatch::Static, "#{root}/app/assets/vendor")
       end
     end
 
+    def serve_static_preview_assets?(app_config)
+      app_config.view_component.show_previews && app_config.public_file_server.enabled
+    end
+
     initializer "compiler mode" do |_app|
       ViewComponent::Compiler.mode = if Rails.env.development? || Rails.env.test?
         ViewComponent::Compiler::DEVELOPMENT_MODE
@@ -151,6 +164,16 @@ module ViewComponent
         end
       end
 
+      # :nocov:
+      if RUBY_VERSION < "3.0.0"
+        ViewComponent::Deprecation.deprecation_warning("Support for Ruby versions < 3.0.0", "ViewComponent 4.0 will remove support for Ruby versions < 3.0.0 ")
+      end
+
+      if Rails.version.to_f < 6.1
+        ViewComponent::Deprecation.deprecation_warning("Support for Rails versions < 6.1", "ViewComponent 4.0 will remove support for Rails versions < 6.1 ")
+      end
+      # :nocov:
+
       app.executor.to_run :before do
         CompileCache.invalidate! unless ActionView::Base.cache_template_loading
       end

data/lib/view_component/errors.rb

@@ -104,7 +104,10 @@ module ViewComponent
       "string, or callable (that is proc, lambda, etc)"
   end
 
-  class SlotPredicateNameError < StandardError
+  class InvalidSlotNameError < StandardError
+  end
+
+  class SlotPredicateNameError < InvalidSlotNameError
     MESSAGE =
       "COMPONENT declares a slot named SLOT_NAME, which ends with a question mark.\n\n" \
       "This isn't allowed because the ViewComponent framework already provides predicate " \
@@ -126,7 +129,7 @@ module ViewComponent
     end
   end
 
-  class ReservedSingularSlotNameError < StandardError
+  class ReservedSingularSlotNameError < InvalidSlotNameError
     MESSAGE =
       "COMPONENT declares a slot named SLOT_NAME, which is a reserved word in the ViewComponent framework.\n\n" \
       "To fix this issue, choose a different name."
@@ -136,7 +139,7 @@ module ViewComponent
     end
   end
 
-  class ReservedPluralSlotNameError < StandardError
+  class ReservedPluralSlotNameError < InvalidSlotNameError
     MESSAGE =
       "COMPONENT declares a slot named SLOT_NAME, which is a reserved word in the ViewComponent framework.\n\n" \
       "To fix this issue, choose a different name."
@@ -146,6 +149,16 @@ module ViewComponent
     end
   end
 
+  class UncountableSlotNameError < InvalidSlotNameError
+    MESSAGE =
+      "COMPONENT declares a slot named SLOT_NAME, which is an uncountable word\n\n" \
+      "To fix this issue, choose a different name."
+
+    def initialize(klass_name, slot_name)
+      super(MESSAGE.gsub("COMPONENT", klass_name.to_s).gsub("SLOT_NAME", slot_name.to_s))
+    end
+  end
+
   class ContentAlreadySetForPolymorphicSlotError < StandardError
     MESSAGE = "Content for slot SLOT_NAME has already been provided."
 
@@ -187,6 +200,7 @@ module ViewComponent
       "`#controller` to a [`#before_render` method](https://viewcomponent.org/api.html#before_render--void)."
   end
 
+  # :nocov:
   class NoMatchingTemplatesForPreviewError < StandardError
     MESSAGE = "Found 0 matches for templates for TEMPLATE_IDENTIFIER."
 
@@ -202,6 +216,7 @@ module ViewComponent
       super(MESSAGE.gsub("TEMPLATE_IDENTIFIER", template_identifier))
     end
   end
+  # :nocov:
 
   class SystemTestControllerOnlyAllowedInTestError < BaseError
     MESSAGE = "ViewComponent SystemTest controller must only be called in a test environment for security reasons."

data/lib/view_component/preview.rb

@@ -4,7 +4,11 @@ require "active_support/descendants_tracker"
 
 module ViewComponent # :nodoc:
   class Preview
-    include Rails.application.routes.url_helpers if defined?(Rails.application.routes.url_helpers)
+    if defined?(Rails.application.routes.url_helpers)
+      # Workaround from https://stackoverflow.com/questions/20853526/make-yard-ignore-certain-class-extensions to appease YARD
+      send(:include, Rails.application.routes.url_helpers)
+    end
+
     include ActionView::Helpers::TagHelper
     include ActionView::Helpers::AssetTagHelper
     extend ActiveSupport::DescendantsTracker

data/lib/view_component/rails/tasks/view_component.rake

@@ -7,7 +7,8 @@ namespace :view_component do
     # :nocov:
     require "rails/code_statistics"
 
-    ::STATS_DIRECTORIES << ["ViewComponents", ViewComponent::Base.view_component_path]
+    dir = ViewComponent::Base.view_component_path
+    ::STATS_DIRECTORIES << ["ViewComponents", dir] if File.directory?(Rails.root + dir)
     # :nocov:
   end
 end

data/lib/view_component/slotable.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "active_support/concern"
+require "active_support/inflector/inflections"
 require "view_component/slot"
 
 module ViewComponent
@@ -92,11 +93,11 @@ module ViewComponent
             get_slot(slot_name)
           end
 
-          define_method "#{slot_name}?" do
+          define_method :"#{slot_name}?" do
             get_slot(slot_name).present?
           end
 
-          define_method "with_#{slot_name}_content" do |content|
+          define_method :"with_#{slot_name}_content" do |content|
             send(setter_method_name) { content.to_s }
 
             self
@@ -159,7 +160,7 @@ module ViewComponent
           end
           ruby2_keywords(setter_method_name) if respond_to?(:ruby2_keywords, true)
 
-          define_method "with_#{singular_name}_content" do |content|
+          define_method :"with_#{singular_name}_content" do |content|
             send(setter_method_name) { content.to_s }
 
             self
@@ -179,7 +180,7 @@ module ViewComponent
             get_slot(slot_name)
           end
 
-          define_method "#{slot_name}?" do
+          define_method :"#{slot_name}?" do
             get_slot(slot_name).present?
           end
 
@@ -210,7 +211,7 @@ module ViewComponent
           get_slot(slot_name)
         end
 
-        define_method("#{slot_name}?") do
+        define_method(:"#{slot_name}?") do
           get_slot(slot_name).present?
         end
 
@@ -245,7 +246,7 @@ module ViewComponent
           end
           ruby2_keywords(setter_method_name) if respond_to?(:ruby2_keywords, true)
 
-          define_method "with_#{poly_slot_name}_content" do |content|
+          define_method :"with_#{poly_slot_name}_content" do |content|
             send(setter_method_name) { content.to_s }
 
             self
@@ -295,6 +296,8 @@ module ViewComponent
           raise ReservedPluralSlotNameError.new(name, slot_name)
         end
 
+        raise_if_slot_name_uncountable(slot_name)
+        raise_if_slot_conflicts_with_call(slot_name)
         raise_if_slot_ends_with_question_mark(slot_name)
         raise_if_slot_registered(slot_name)
       end
@@ -308,6 +311,7 @@ module ViewComponent
           raise ReservedSingularSlotNameError.new(name, slot_name)
         end
 
+        raise_if_slot_conflicts_with_call(slot_name)
         raise_if_slot_ends_with_question_mark(slot_name)
         raise_if_slot_registered(slot_name)
       end
@@ -320,7 +324,20 @@ module ViewComponent
       end
 
       def raise_if_slot_ends_with_question_mark(slot_name)
-        raise SlotPredicateNameError.new(name, slot_name) if slot_name.to_s.ends_with?("?")
+        raise SlotPredicateNameError.new(name, slot_name) if slot_name.to_s.end_with?("?")
+      end
+
+      def raise_if_slot_conflicts_with_call(slot_name)
+        if slot_name.start_with?("call_")
+          raise InvalidSlotNameError, "Slot cannot start with 'call_'. Please rename #{slot_name}"
+        end
+      end
+
+      def raise_if_slot_name_uncountable(slot_name)
+        slot_name = slot_name.to_s
+        if slot_name.pluralize == slot_name.singularize
+          raise UncountableSlotNameError.new(name, slot_name)
+        end
       end
     end
 

data/lib/view_component/test_helpers.rb

@@ -48,10 +48,14 @@ module ViewComponent
       @rendered_content =
         if Rails.version.to_f >= 6.1
           vc_test_controller.view_context.render(component, args, &block)
+
+        # :nocov:
         else
           vc_test_controller.view_context.render_component(component, &block)
         end
 
+      # :nocov:
+
       Nokogiri::HTML.fragment(@rendered_content)
     end
 
@@ -163,29 +167,47 @@ module ViewComponent
     # end
     # ```
     #
-    # @param path [String] The path to set for the current request.
+    # To specify a request method, pass the method param:
+    #
+    # ```ruby
+    # with_request_url("/users/42", method: "POST") do
+    #   render_inline(MyComponent.new)
+    # end
+    # ```
+    #
+    # @param full_path [String] The path to set for the current request.
     # @param host [String] The host to set for the current request.
-    def with_request_url(path, host: nil)
+    # @param method [String] The request method to set for the current request.
+    def with_request_url(full_path, host: nil, method: nil, format: :html)
       old_request_host = vc_test_request.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_format = vc_test_request.format.symbol
       old_controller = defined?(@vc_test_controller) && @vc_test_controller
 
-      path, query = path.split("?", 2)
+      path, query = full_path.split("?", 2)
+      vc_test_request.instance_variable_set(:@fullpath, full_path)
+      vc_test_request.instance_variable_set(:@original_fullpath, full_path)
       vc_test_request.host = host if host
+      vc_test_request.request_method = method if method
       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))
+      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)
+      vc_test_request.format = format
       yield
     ensure
       vc_test_request.host = old_request_host
+      vc_test_request.request_method = old_request_method
       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.format = old_request_format
       @vc_test_controller = old_controller
     end
 
@@ -233,9 +255,11 @@ module ViewComponent
 
     def __vc_test_helpers_preview_class
       result = if respond_to?(:described_class)
+        # :nocov:
         raise "`render_preview` expected a described_class, but it is nil." if described_class.nil?
 
         "#{described_class}Preview"
+        # :nocov:
       else
         self.class.name.gsub("Test", "Preview")
       end
@@ -243,5 +267,6 @@ module ViewComponent
     rescue NameError
       raise NameError, "`render_preview` expected to find #{result}, but it does not exist."
     end
+    # :nocov:
   end
 end

data/lib/view_component/translatable.rb

@@ -10,6 +10,7 @@ module ViewComponent
     extend ActiveSupport::Concern
 
     HTML_SAFE_TRANSLATION_KEY = /(?:_|\b)html\z/
+    TRANSLATION_EXTENSIONS = %w[yml yaml].freeze
 
     included do
       class_attribute :i18n_backend, instance_writer: false, instance_predicate: false
@@ -23,9 +24,16 @@ module ViewComponent
       def build_i18n_backend
         return if compiled?
 
-        self.i18n_backend = if (translation_files = sidecar_files(%w[yml yaml])).any?
-          # Returning nil cleans up if translations file has been removed since the last compilation
+        # We need to load the translations files from the ancestors so a component
+        # can inherit translations from its parent and is able to overwrite them.
+        translation_files = ancestors.reverse_each.with_object([]) do |ancestor, files|
+          if ancestor.is_a?(Class) && ancestor < ViewComponent::Base
+            files.concat(ancestor.sidecar_files(TRANSLATION_EXTENSIONS))
+          end
+        end
 
+        # In development it will become nil if the translations file is removed
+        self.i18n_backend = if translation_files.any?
           I18nBackend.new(
             i18n_scope: i18n_scope,
             load_paths: translation_files
@@ -130,8 +138,7 @@ module ViewComponent
     end
 
     def html_escape_translation_options!(options)
-      options.each do |name, value|
-        next if ::I18n.reserved_keys_pattern.match?(name)
+      options.except(*::I18n::RESERVED_KEYS).each do |name, value|
         next if name == :count && value.is_a?(Numeric)
 
         options[name] = ERB::Util.html_escape(value.to_s)

data/lib/view_component/use_helpers.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ViewComponent::UseHelpers
+  extend ActiveSupport::Concern
+
+  class_methods do
+    def use_helpers(*args)
+      args.each do |helper_method|
+        class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+          def #{helper_method}(*args, &block)
+            raise HelpersCalledBeforeRenderError if view_context.nil?
+            __vc_original_view_context.#{helper_method}(*args, &block)
+          end
+        RUBY
+
+        ruby2_keywords(helper_method) if respond_to?(:ruby2_keywords, true)
+      end
+    end
+  end
+end

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 3
-    MINOR = 5
+    MINOR = 10
     PATCH = 0
     PRE = nil
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 3.5.0
+  version: 3.10.0
 platform: ruby
 authors:
 - ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-07-24 00:00:00.000000000 Z
+date: 2024-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -78,14 +78,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 2.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.12.0
+        version: 2.13.0
 - !ruby/object:Gem::Dependency
   name: better_html
   requirement: !ruby/object:Gem::Requirement
@@ -302,14 +302,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.25
+        version: 0.9.34
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.9.25
+        version: 0.9.34
 - !ruby/object:Gem::Dependency
   name: yard-activesupport-concern
   requirement: !ruby/object:Gem::Requirement
@@ -395,6 +395,7 @@ files:
 - lib/view_component/test_case.rb
 - lib/view_component/test_helpers.rb
 - lib/view_component/translatable.rb
+- lib/view_component/use_helpers.rb
 - lib/view_component/version.rb
 - lib/view_component/with_content_helper.rb
 - lib/yard/mattr_accessor_handler.rb
@@ -420,7 +421,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.5
+rubygems_version: 3.5.3
 signing_key:
 specification_version: 4
 summary: A framework for building reusable, testable & encapsulated view components