view_component 3.20.0 → 3.22.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 84bc019145d592e5a7f4dbb439cc960497ac347e12c2a6f73d7544a777365522
-  data.tar.gz: 2832c147430779d124335b8e82c915115b5b6840ab02365df551f5313621e85c
+  metadata.gz: b6afc3fe994c0954654d58d797e36d274013494e6caec61ef1b5535a4a5a4267
+  data.tar.gz: ae921110a568f5e212b0c2d60cf31bf4ac7628b961a65cde871577f13fddee60
 SHA512:
-  metadata.gz: ccbe1677fec16d8de063aafe220ada3ee0647d9963d91f269ef3081b9b2edffc4bf2f535c2097a730d72e80521a9367e97353927997f353f3ec59923e2611deb
-  data.tar.gz: d52f357464701228bc686f4ea367974a287ce4fcd895845814f9a175635750664b705411c096f3f01c0bad0914a1db95573f50d12ff1b0e7d9029a55adf492b8
+  metadata.gz: 240679c690a13c69669173be5c076271e1a2f0f02dfabfc2bdbfa49c0b03cbd7456e88204c84be3e7b85c703c606270b3c794f47f845d3062c6a9f620fda9da2
+  data.tar.gz: da6b4298a67311608e1641c5ace24e321e6270fb67921f2bb6f70cce9dedb7f53b2ea8006acb193775ce4d4f6a963338f310d754bc95aac6c793a9b52abddf62

data/app/controllers/concerns/view_component/preview_actions.rb

@@ -14,7 +14,14 @@ module ViewComponent
 
       # Including helpers here ensures that we're loading the
       # latest version of helpers if code-reloading is enabled
-      helper :all if include_all_helpers
+      if include_all_helpers
+        helper :all
+      else
+        # :nocov:
+        # Always provide the #view_source helper
+        helper PreviewHelper
+        # :nocov:
+      end
     end
 
     def index

data/app/helpers/preview_helper.rb

@@ -22,7 +22,7 @@ module PreviewHelper
     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:)
+  def find_template_data_for_preview_source(lookup_context:, template_identifier:)
     template = lookup_context.find_template(template_identifier)
 
     if Rails.version.to_f >= 6.1 || template.source.present?

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

@@ -7,7 +7,7 @@
         <%= h @preview.preview_source(@example_name) %>
       </code>
     <% else %>
-      <% template_data = find_template_data(lookup_context: @view_renderer.lookup_context, template_identifier: @render_args[:template]) %>
+      <% template_data = find_template_data_for_preview_source(lookup_context: @view_renderer.lookup_context, template_identifier: @render_args[:template]) %>
       <code class="language-<%= template_data[:prism_language_name] %>">
         <%= h template_data[:source] %>
       </code>

data/docs/CHANGELOG.md

@@ -10,6 +10,76 @@ nav_order: 5
 
 ## main
 
+## 3.22.0
+
+* Rewrite `ViewComponents at GitHub` documentation as more general `Best practices`.
+
+    *Phil Schalm*, *Joel Hawksley*
+
+* Add unused mechanism for inheriting config from parent modules to enable future engine-local configuration.
+
+    *Simon Fish*
+
+* Improve handling of malformed component edge case when mocking components in tests.
+
+    *Martin Meyerhoff*, *Joel Hawksley*
+
+* Add Content Harmony & Learn To Be to list of companies using ViewComponent.
+
+    *Kane Jamison*
+
+* Clarify error message about render-dependent logic.
+
+  Error messages about render-dependent logic were sometimes inaccurate, saying `during initialization` despite also being raised after a component had been initialized but before it was rendered.
+
+    *Joel Hawksley*
+
+* Remove JS and CSS docs as they proved difficult to maintain and lacked consensus.
+
+    *Joel Hawksley*
+
+* Do not prefix release tags with `v`, per recommendation from @bkuhlmann.
+
+    *Joel Hawksley*
+
+* Add ruby 3.4 support to CI.
+
+    *Reegan Viljoen*
+
+* Add HomeStyler AI to list of companies using ViewComponent.
+
+    *JP Balarini*
+
+## 3.21.0
+
+* Updates testing docs to include an example of how to use with RSpec.
+
+    *Rylan Bowers*
+
+* Add `--skip-suffix` option to component generator.
+
+    *KAWAKAMI Moeki*
+
+* Add FreeATS to list of companies using ViewComponent.
+
+    *Ilia Liamshin*
+
+* Ensure HTML output safety wrapper is used for all inline templates.
+
+    *Joel Hawksley*
+
+* Expose `.identifier` method as part of public API.
+
+    *Joel Hawksley*
+
+* Add rails 8 support to CI.
+
+    *Reegan Viljoen*
+
+* Updates ActionText compatibility documentation to reference `rich_textarea_tag` for Rails 8.0 support.
+
+    *Alvin Crespo*
+
 ## 3.20.0
 
 * Allow rendering `with_collection` to accept an optional `spacer_component` to be rendered between each item.
@@ -188,6 +258,10 @@ nav_order: 5
 
     *Reegan Viljoen*
 
+* Fix a bug where component previews would crash with "undefined local variable or method `preview_source`."
+
+    *Henning Koch*
+
 ## 3.12.1
 
 * Ensure content is rendered correctly for forwarded slots.

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

@@ -19,9 +19,10 @@ module Rails
       class_option :sidecar, type: :boolean, default: false
       class_option :stimulus, type: :boolean,
         default: ViewComponent::Base.config.generate.stimulus_controller
+      class_option :skip_suffix, type: :boolean, default: false
 
       def create_component_file
-        template "component.rb", File.join(component_path, class_path, "#{file_name}_component.rb")
+        template "component.rb", File.join(component_path, class_path, "#{file_name}#{options[:skip_suffix] ? "" : "_component"}.rb")
       end
 
       hook_for :test_framework

data/lib/rails/generators/component/templates/component.rb.tt

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 <% module_namespacing do -%>
-class <%= class_name %>Component < <%= parent_class %>
+class <%= class_name %><%= options[:skip_suffix] ? "" : "Component" %> < <%= parent_class %>
 <%- if initialize_signature -%>
   def initialize(<%= initialize_signature %>)
     <%= initialize_body %>

data/lib/view_component/base.rb

@@ -25,6 +25,10 @@ module ViewComponent
       #
       # @return [ActiveSupport::OrderedOptions]
       def config
+        module_parents.each do |m|
+          config = m.try(:config).try(:view_component)
+          return config if config
+        end
         ViewComponent::Config.current
       end
     end
@@ -108,14 +112,7 @@ module ViewComponent
       before_render
 
       if render?
-        rendered_template =
-          if compiler.renders_template_for?(@__vc_variant, __vc_request&.format&.to_sym)
-            render_template_for(@__vc_variant, __vc_request&.format&.to_sym)
-          else
-            maybe_escape_html(render_template_for(@__vc_variant, __vc_request&.format&.to_sym)) 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.to_s
+        rendered_template = render_template_for(@__vc_variant, __vc_request&.format&.to_sym).to_s
 
         # Avoid allocating new string when output_preamble and output_postamble are blank
         if output_preamble.blank? && output_postamble.blank?
@@ -358,10 +355,6 @@ module ViewComponent
       end
     end
 
-    def compiler
-      @compiler ||= self.class.compiler
-    end
-
     # Set the controller used for testing components:
     #
     # ```ruby
@@ -457,8 +450,16 @@ module ViewComponent
     #  Defaults to `false`.
 
     class << self
+      # The file path of the component Ruby file.
+      #
+      # @return [String]
+      attr_reader :identifier
+
       # @private
-      attr_accessor :source_location, :virtual_path
+      attr_writer :identifier
+
+      # @private
+      attr_accessor :virtual_path
 
       # Find sidecar files for the given extensions.
       #
@@ -468,13 +469,13 @@ module ViewComponent
       # For example, one might collect sidecar CSS files that need to be compiled.
       # @param extensions [Array<String>] Extensions of which to return matching sidecar files.
       def sidecar_files(extensions)
-        return [] unless source_location
+        return [] unless identifier
 
         extensions = extensions.join(",")
 
         # view files in a directory named like the component
-        directory = File.dirname(source_location)
-        filename = File.basename(source_location, ".rb")
+        directory = File.dirname(identifier)
+        filename = File.basename(identifier, ".rb")
         component_name = name.demodulize.underscore
 
         # Add support for nested components defined in the same file.
@@ -499,7 +500,7 @@ module ViewComponent
 
         sidecar_directory_files = Dir["#{directory}/#{component_name}/#{filename}.*{#{extensions}}"]
 
-        (sidecar_files - [source_location] + sidecar_directory_files + nested_component_files).uniq
+        (sidecar_files - [identifier] + sidecar_directory_files + nested_component_files).uniq
       end
 
       # Render a component for each element in a collection ([documentation](/guide/collections)):
@@ -548,11 +549,11 @@ module ViewComponent
         # has been re-defined by the consuming application, likely in ApplicationComponent.
         # We use `base_label` method here instead of `label` to avoid cases where the method
         # owner is included in a prefix like `ApplicationComponent.inherited`.
-        child.source_location = caller_locations(1, 10).reject { |l| l.base_label == "inherited" }[0].path
+        child.identifier = caller_locations(1, 10).reject { |l| l.base_label == "inherited" }[0].path
 
         # If Rails application is loaded, removes the first part of the path and the extension.
         if defined?(Rails) && Rails.application
-          child.virtual_path = child.source_location.gsub(
+          child.virtual_path = child.identifier.gsub(
             /(.*#{Regexp.quote(ViewComponent::Base.config.view_component_path)})|(\.rb)/, ""
           )
         end
@@ -590,15 +591,6 @@ module ViewComponent
         @__vc_compiler ||= Compiler.new(self)
       end
 
-      # @private
-      def identifier
-        # :nocov:
-        Kernel.warn("WARNING: The #{self.class}.identifier is undocumented and was meant for internal framework usage only. As it is no longer used by the framework it will be removed in a coming non-breaking ViewComponent release.")
-
-        source_location
-        # :nocov:
-      end
-
       # Set the parameter name used when rendering elements of a collection ([documentation](/guide/collections)):
       #
       # ```ruby
@@ -636,7 +628,7 @@ module ViewComponent
       # validate that the default parameter name
       # is accepted, as support for collection
       # rendering is optional.
-      # @private TODO: add documentation
+      # @private
       def validate_collection_parameter!(validate_default: false)
         parameter = validate_default ? collection_parameter : provided_collection_parameter
 
@@ -656,7 +648,7 @@ module ViewComponent
       # Ensure the component initializer doesn't define
       # invalid parameters that could override the framework's
       # methods.
-      # @private TODO: add documentation
+      # @private
       def validate_initialization_parameters!
         return unless initialize_parameter_names.include?(RESERVED_PARAMETER)
 

data/lib/view_component/compiler.rb

@@ -13,7 +13,6 @@ module ViewComponent
     def initialize(component)
       @component = component
       @lock = Mutex.new
-      @rendered_templates = Set.new
     end
 
     def compiled?
@@ -56,10 +55,6 @@ module ViewComponent
       end
     end
 
-    def renders_template_for?(variant, format)
-      @rendered_templates.include?([variant, format])
-    end
-
     private
 
     attr_reader :templates
@@ -71,9 +66,9 @@ module ViewComponent
 
       method_body =
         if @templates.one?
-          @templates.first.safe_method_name
+          @templates.first.safe_method_name_call
         elsif (template = @templates.find(&:inline?))
-          template.safe_method_name
+          template.safe_method_name_call
         else
           branches = []
 
@@ -88,13 +83,13 @@ module ViewComponent
                 ].join(" && ")
               end
 
-            branches << [conditional, template.safe_method_name]
+            branches << [conditional, template.safe_method_name_call]
           end
 
           out = branches.each_with_object(+"") do |(conditional, branch_body), memo|
             memo << "#{(!memo.present?) ? "if" : "elsif"} #{conditional}\n  #{branch_body}\n"
           end
-          out << "else\n  #{templates.find { _1.variant.nil? && _1.default_format? }.safe_method_name}\nend"
+          out << "else\n  #{templates.find { _1.variant.nil? && _1.default_format? }.safe_method_name_call}\nend"
         end
 
       @component.silence_redefinition_of_method(:render_template_for)
@@ -196,10 +191,6 @@ module ViewComponent
               variant: variant
             )
 
-            # TODO: We should consider inlining the HTML output safety logic into the compiled render_template_for
-            # instead of this indirect approach
-            @rendered_templates << [out.variant, out.this_format]
-
             out
           end
 

data/lib/view_component/configurable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Configurable
+    extend ActiveSupport::Concern
+
+    included do
+      next if respond_to?(:config) && config.respond_to?(:view_component) && config.respond_to_missing?(:test_controller)
+
+      include ActiveSupport::Configurable
+
+      configure do |config|
+        config.view_component ||= ActiveSupport::InheritableOptions.new
+      end
+    end
+  end
+end

data/lib/view_component/errors.rb

@@ -177,7 +177,7 @@ module ViewComponent
 
   class TranslateCalledBeforeRenderError < BaseError
     MESSAGE =
-      "`#translate` can't be used during initialization as it depends " \
+      "`#translate` can't be used before rendering as it depends " \
       "on the view context that only exists once a ViewComponent is passed to " \
       "the Rails render pipeline.\n\n" \
       "It's sometimes possible to fix this issue by moving code dependent on " \
@@ -186,7 +186,7 @@ module ViewComponent
 
   class HelpersCalledBeforeRenderError < BaseError
     MESSAGE =
-      "`#helpers` can't be used during initialization as it depends " \
+      "`#helpers` can't be used before rendering as it depends " \
       "on the view context that only exists once a ViewComponent is passed to " \
       "the Rails render pipeline.\n\n" \
       "It's sometimes possible to fix this issue by moving code dependent on " \
@@ -195,7 +195,7 @@ module ViewComponent
 
   class ControllerCalledBeforeRenderError < BaseError
     MESSAGE =
-      "`#controller` can't be used during initialization, as it depends " \
+      "`#controller` can't be used before rendering, as it depends " \
       "on the view context that only exists once a ViewComponent is passed to " \
       "the Rails render pipeline.\n\n" \
       "It's sometimes possible to fix this issue by moving code dependent on " \

data/lib/view_component/instrumentation.rb

@@ -13,7 +13,7 @@ module ViewComponent # :nodoc:
         notification_name,
         {
           name: self.class.name,
-          identifier: self.class.source_location
+          identifier: self.class.identifier
         }
       ) do
         super

data/lib/view_component/template.rb

@@ -59,6 +59,14 @@ module ViewComponent
       @component.define_method(safe_method_name, @component.instance_method(@call_method_name))
     end
 
+    def safe_method_name_call
+      return safe_method_name unless inline_call?
+
+      "maybe_escape_html(#{safe_method_name}) " \
+      "{ Kernel.warn(\"WARNING: The #{@component} component rendered HTML-unsafe output. " \
+      "The output will be automatically escaped, but you may want to investigate.\") } "
+    end
+
     def requires_compiled_superclass?
       inline_call? && !defined_on_self?
     end

data/lib/view_component/version.rb

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

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 3.20.0
+  version: 3.22.0
 platform: ruby
 authors:
 - ViewComponent Team
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-31 00:00:00.000000000 Z
+date: 2025-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -48,16 +47,16 @@ dependencies:
   name: concurrent-ruby
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.3.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.3.4
 - !ruby/object:Gem::Dependency
   name: allocation_stats
   requirement: !ruby/object:Gem::Requirement
@@ -324,6 +323,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 4.9.0
+- !ruby/object:Gem::Dependency
+  name: sprockets-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.4.2
 - !ruby/object:Gem::Dependency
   name: standard
   requirement: !ruby/object:Gem::Requirement
@@ -380,20 +393,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '5.1'
-- !ruby/object:Gem::Dependency
-  name: sprockets-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.4.2
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 3.4.2
 - !ruby/object:Gem::Dependency
   name: turbo-rails
   requirement: !ruby/object:Gem::Requirement
@@ -548,8 +547,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
-email:
+- !ruby/object:Gem::Dependency
+  name: propshaft
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 executables: []
 extensions: []
 extra_rdoc_files: []
@@ -598,6 +609,7 @@ files:
 - lib/view_component/compiler.rb
 - lib/view_component/component_error.rb
 - lib/view_component/config.rb
+- lib/view_component/configurable.rb
 - lib/view_component/deprecation.rb
 - lib/view_component/docs_builder_component.html.erb
 - lib/view_component/docs_builder_component.rb
@@ -633,7 +645,6 @@ metadata:
   allowed_push_host: https://rubygems.org
   source_code_uri: https://github.com/viewcomponent/view_component
   changelog_uri: https://github.com/ViewComponent/view_component/blob/main/docs/CHANGELOG.md
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -648,8 +659,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.3
-signing_key:
+rubygems_version: 3.6.2
 specification_version: 4
 summary: A framework for building reusable, testable & encapsulated view components
   in Ruby on Rails.