view_component 3.8.0 → 3.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1bb442fbd129d82aadace3ec12fcf80c62bb9fbd9f0f204ac6668aec801e904b
-  data.tar.gz: d39cbee68cace857998a380a80bcd7cd0b5c0b6d22774d36a82e2072d2a8631f
+  metadata.gz: d3f4f53b04ea58ed971bef33e1bea8ab65c2564c64a49927ca5db90c118d23bc
+  data.tar.gz: 1a6b6024ffd5baf72cb80726b0853cf3fcab80d43505c87648cc57d6726e9185
 SHA512:
-  metadata.gz: 966508a6e21eae5af04e14fabdfd43fbc77dd85f39bc3332b6519686a5da1eb404a8f23e4b25a90cafeaa9143a81437f6a4ca0cf0c57690132bd384030b66071
-  data.tar.gz: 4bc638d9dc1f925a6aa2c75e6f2f0e0f10ed01e61e39eac37c6a2f496f4eff66f50022ec8f7850c94761a40c3a064365f1b02957c35aaa15b3c17fc0f796b328
+  metadata.gz: 0f75de114591fca8e662e6fa15086c0b6b11c5862a05e68abff123ba19b7b23b7f67e7b65f8adca8a78688011254117643e9f0e76b92e5a0c0c51d82ecb85194
+  data.tar.gz: 9771fc3c30b8472bb2f0793573926cd7b05e8f991091af18f8e51cfd5370ea8ac7f1eff40488eb0e1434a81683e901fcd74659763620f2e5ae8a26d4db0c943b

data/docs/CHANGELOG.md

@@ -10,6 +10,58 @@ 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.
@@ -225,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

@@ -104,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
@@ -151,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
@@ -221,6 +235,7 @@ module ViewComponent
     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
@@ -301,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
@@ -616,7 +669,7 @@ module ViewComponent
 
       # @private
       def collection_counter_parameter
-        "#{collection_parameter}_counter".to_sym
+        :"#{collection_parameter}_counter"
       end
 
       # @private
@@ -626,7 +679,7 @@ module ViewComponent
 
       # @private
       def collection_iteration_parameter
-        "#{collection_parameter}_iteration".to_sym
+        :"#{collection_parameter}_iteration"
       end
 
       # @private

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?

data/lib/view_component/engine.rb

@@ -81,6 +81,8 @@ module ViewComponent
       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
@@ -99,6 +101,8 @@ module ViewComponent
       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
@@ -160,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/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

@@ -93,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
@@ -160,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
@@ -180,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
 
@@ -211,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
 
@@ -246,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

data/lib/view_component/test_helpers.rb

@@ -175,16 +175,17 @@ module ViewComponent
     # end
     # ```
     #
-    # @param path [String] The path to set for the current request.
+    # @param full_path [String] The path to set for the current request.
     # @param host [String] The host to set for the current request.
     # @param method [String] The request method to set for the current request.
-    def with_request_url(full_path, host: nil, method: nil)
+    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 = full_path.split("?", 2)
@@ -197,6 +198,7 @@ module ViewComponent
       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
@@ -205,6 +207,7 @@ module ViewComponent
       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
 
@@ -252,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
@@ -262,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/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 3
-    MINOR = 8
+    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.8.0
+  version: 3.10.0
 platform: ruby
 authors:
 - ViewComponent Team
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-11-27 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
@@ -421,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