view_component 2.44.0 → 2.48.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2542c18f4fbd3071c18fb27d8edb563021ad201fa5cc4d0c02fb8190918b6920
-  data.tar.gz: 7c7fb2ef2a79ed3816655cd8f27a52248fe0181957487a9b0297968914034c9f
+  metadata.gz: 3abce9e08dcb71614178ed68b9c8443211ff78790911057752d8fda6fbb194b7
+  data.tar.gz: 3ac0a8ff1d7cafd2eb12e04a24f1d8f3362675833e4fda780bc238b8fc5ed41f
 SHA512:
-  metadata.gz: 4e43d3b7398bd838b25e87a566ce82229e82343f64a9f70230b90d4eb2b0afdc8e0ffda355acd032877d0751082e3e4342ecd53955011de89ea1ce341c6b7a80
-  data.tar.gz: 3d90591c1d4d3cbff9d8e4c7dd1f94015ddce95e62f8284586dda63da99311609c3558fd353f0cf3c6b8c58f4c9a0b18f0fa91e60aa2275e57284cb2e10bff4a
+  metadata.gz: dba31d0d37e73b7a1e26863d167f5d1eaefb8c5f53d9f542e47667090802b5f53b5c6b9c4b0a9188bf76f42d375c5d7a2cd3024065620aa9ff40b15911706cb8
+  data.tar.gz: f329872b25f36fe8fa0d018c2a5847ed0b6e47b095d16a27e89d2b0c7180f938d09730d0868405483a8e7c4fe4075afed56927a018b7a273ac4c94950d174fac

data/README.md

@@ -1,4 +1,5 @@
-<img src="/docs/logo/github-readme-logo.svg" alt="ViewComponent logo" width="400">
+![ViewComponent logo](/docs/logo/readme-light.svg#gh-light-mode-only)
+![ViewComponent logo](/docs/logo/readme-dark.svg#gh-dark-mode-only)
 
 A framework for building reusable, testable & encapsulated view components in Ruby on Rails.
 

data/app/controllers/view_components_controller.rb

@@ -29,12 +29,11 @@ class ViewComponentsController < Rails::ApplicationController # :nodoc:
       @example_name = File.basename(params[:path])
       @render_args = @preview.render_args(@example_name, params: params.permit!)
       layout = determine_layout(@render_args[:layout], prepend_views: false)[:layout]
-      template = @render_args[:template]
       locals = @render_args[:locals]
       opts = {}
       opts[:layout] = layout if layout.present? || layout == false
       opts[:locals] = locals if locals.present?
-      render template, opts # rubocop:disable GitHub/RailsControllerRenderLiteral
+      render "view_components/preview", opts # rubocop:disable GitHub/RailsControllerRenderLiteral
     end
   end
 

data/app/helpers/preview_helper.rb

@@ -4,16 +4,64 @@ module PreviewHelper
   AVAILABLE_PRISM_LANGUAGES = ["ruby", "erb", "haml"]
   FALLBACK_LANGUAGE = "ruby"
 
-  def prism_language_name(template:)
+  def preview_source
+    return if @render_args.nil?
+
+    render "preview_source" # rubocop:disable GitHub/RailsViewRenderPathsExist
+  end
+
+  def find_template_data(lookup_context:, template_identifier:)
+    template = lookup_context.find_template(template_identifier)
+
+    if Rails.version.to_f >= 6.1 || template.source.present?
+      return {
+        source: template.source,
+        prism_language_name: prism_language_name_by_template(template: template)
+      }
+    else
+      # Fetch template source via finding it through preview paths
+      # to accomodate source view when exclusively using templates
+      # for previews for Rails < 6.1.
+      all_template_paths = ViewComponent::Base.preview_paths.map do |preview_path|
+        Dir.glob("#{preview_path}/**/*")
+      end.flatten
+
+      # Search for templates the contain `html`.
+      matching_templates = all_template_paths.find_all do |template|
+        template =~ /#{template_identifier}*.(html)/
+      end
+
+      # In-case of a conflict due to multiple template files with
+      # the same name
+      raise "found 0 matches for templates for #{template_identifier}." if matching_templates.empty?
+      raise "found multiple templates for #{template_identifier}." if matching_templates.size > 1
+
+      template_file_path = matching_templates.first
+      template_source = File.read(template_file_path)
+      prism_language_name = prism_language_name_by_template_path(template_file_path: template_file_path)
+
+      return {
+        source: template_source,
+        prism_language_name: prism_language_name
+      }
+    end
+  end
+
+  private
+
+  def prism_language_name_by_template(template:)
     language = template.identifier.split(".").last
+
     return FALLBACK_LANGUAGE unless AVAILABLE_PRISM_LANGUAGES.include? language
 
     language
   end
 
-  def preview_source
-    return if @render_args.nil?
+  def prism_language_name_by_template_path(template_file_path:)
+    language = template_file_path.gsub(".html", "").split(".").last
 
-    render "preview_source" # rubocop:disable GitHub/RailsViewRenderPathsExist
+    return FALLBACK_LANGUAGE unless AVAILABLE_PRISM_LANGUAGES.include? language
+
+    language
   end
 end

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

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

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

@@ -1,7 +1,11 @@
-<% if ViewComponent::Base.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
-  <%= render(@render_args[:component], @render_args[:args], &@render_args[:block]) %>
+<% if @render_args[:component] %>
+  <% if ViewComponent::Base.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
+    <%= render(@render_args[:component], @render_args[:args], &@render_args[:block]) %>
+  <% else %>
+    <%= render_component(@render_args[:component], &@render_args[:block]) %>
+  <% end %>
 <% else %>
-  <%= render_component(@render_args[:component], &@render_args[:block]) %>
+  <%= render template: @render_args[:template], locals: @render_args[:locals] || {} %>
 <% end %>
 
 <% if ViewComponent::Base.show_previews_source %>

data/docs/CHANGELOG.md

@@ -7,6 +7,203 @@ title: Changelog
 
 ## main
 
+## 2.48.0
+
+* Correct path in example test command in Contributing docs.
+
+    *Mark Wilkinson*
+
+* Update link to GOV.UK Components library in the resources list.
+
+    *Peter Yates*
+
+* Add Lookbook to Resources docs page.
+
+    *Mark Perkins*
+
+* Add blocking compiler mode for use in Rails development and testing modes, improving thread safety.
+
+    *Horia Radu*
+
+* Add generators to support `tailwindcss-rails`.
+
+    *Dino Maric*, *Hans Lemuet*
+
+* Add a namespaced component example to docs.
+
+    *Hans Lemuet*
+
+* Setup `Appraisal` to add flexibility when testing ViewComponent against multiple Rails versions.
+
+    *Hans Lemuet*
+
+* Return correct values for `request.path` and `request.query_string` methods when using the `with_request_url` test helper.
+
+    *Vasiliy Matyushin*
+
+* Improve style in generators docs.
+
+    *Hans Lemuet*
+
+* Correctly type Ruby version strings and update Rails versions used in CI configuration.
+
+    *Hans Lemuet*
+
+* Make `ViewComponent::Collection` act like a collection of view components.
+
+    *Sammy Henningsson*
+
+* Update `@param` of `#render_inline` to include `ViewComponent::Collection`.
+
+    *Yutaka Kamei*
+
+* Add Wecasa to users list.
+
+    *Mohamed Ziata*
+
+## 2.47.0
+
+* Display preview source on previews that exclusively use templates.
+
+    *Edwin Mak*
+
+* Add a test to ensure trailing newlines are stripped when rendering with `#render_in`.
+
+    *Simon Fish*
+
+* Add WEBrick as a depenency to the application.
+
+    *Connor McQuillan*
+
+* Update Ruby version in `.tool-versions`.
+
+    *Connor McQuillan*
+
+* Add a test to ensure blocks can be passed into lambda slots without the need for any other arguments.
+
+    *Simon Fish*
+
+* Add linters for file consistency.
+
+    *Simon Fish*
+
+* Add @boardfish to docs/index.md and sort contributors.
+
+    *Simon Fish*
+
+* Set up Codespaces for bug replication.
+
+    *Simon Fish*
+
+* Add instructions for replicating bugs and failures.
+
+    *Simon Fish*
+
+* Make @boardfish a committer.
+
+    *Joel Hawksley*
+
+* Validate collection parameter with Active Model attribute names.
+
+    *Simon Fish*
+
+* Fix `helpers` not working with component slots when rendered more than 2 component levels deep.
+
+    *Blake Williams*
+
+* Update ruby to the latest versions
+
+    *Pedro Paiva*
+
+* Fix `vale` linter config options.
+
+    *Hans Lemuet*
+
+* Improve Contributing docs to include how to run tests for a specific version on Rails.
+
+    *Hans Lemuet*
+
+* Add failing test for default form builder and documentation around known issue.
+
+    *Simon Fish*
+
+* Add `--locale` flag to the component generator. Generates as many locale files as defined in `I18n.available_locales`, alongside the component.
+* Add config option `config.view_component.generate_locale` to enable project-wide locale generation.
+* Add config option `config.view_component.generate_distinct_locale_files` to enable project-wide per-locale translations file generation.
+
+    *Bob Maerten*
+
+* Add config option `config.view_component.generate_sidecar` to always generate in the sidecar directory.
+
+    *Gleydson Tavares*
+
+## 2.46.0
+
+* Add thread safety to the compiler.
+
+    *Horia Radu*
+
+* Add theme-specific logo images to readme.
+
+    *Dylan Smith*
+
+* Add Orbit to users list.
+
+    *Nicolas Goutay*
+
+* Increase clarity around purpose and use of slots.
+
+    *Simon Fish*
+
+* Deprecate loading `view_component/engine` directly.
+
+  **Upgrade notice**: You should update your `Gemfile` like this:
+
+  ```diff
+  - gem "view_component", require: "view_component/engine"`
+  + gem "view_component"
+  ```
+
+    *Yoshiyuki Hirano*
+
+## 2.45.0
+
+* Remove internal APIs from API documentation, fix link to license.
+
+    *Joel Hawksley*
+
+* Add @yhirano55 to triage team.
+
+    *Joel Hawksley*
+
+* Correct a typo in the sample slots code.
+
+    *Simon Fish*
+
+* Add note about `allowed_queries`.
+
+    *Joel Hawksley*
+
+* Add `vale` content linter.
+
+    *Joel Hawksley*
+
+* Remove `require "rails/generators/test_case"` in generator tests.
+
+    *Yoshiyuki Hirano*
+
+* Suppress zeitwerk warning about circular require.
+
+    *Yoshiyuki Hirano*
+
+* Move `test_unit_generator_test.rb` from `test/view_component/` to `test/generators/`.
+
+    *Yoshiyuki Hirano*
+
+* Unify test code of `TestUnitGeneratorTest` with the other generators tests.
+
+    *Yoshiyuki Hirano*
+
 ## 2.44.0
 
 * Rename internal accessor to use private naming.
@@ -142,7 +339,7 @@ title: Changelog
 
     *Matthew Rider*
 
-* Fix bug where `with_collection_parameter` did not inherit from parent component.
+* Fix bug where `with_collection_parameter` didn't inherit from parent component.
 
     *Will Drexler*, *Christian Campoli*
 
@@ -346,7 +543,7 @@ title: Changelog
 
     *Hans Lemuet*
 
-* Fix bug where ViewComponents did not work in ActionMailers.
+* Fix bug where ViewComponents didn't work in ActionMailers.
 
     *dark-panda*
 
@@ -394,7 +591,7 @@ title: Changelog
 
 ## 2.31.0
 
-_Note: This release includes an underlying change to Slots that may affect incorrect usage of the API, where Slots were set on a line prefixed by `<%=`. The result of setting a Slot should not be returned. (`<%`)_
+_Note: This release includes an underlying change to Slots that may affect incorrect usage of the API, where Slots were set on a line prefixed by `<%=`. The result of setting a Slot shouldn't be returned. (`<%`)_
 
 * Add `#with_content` to allow setting content without a block.
 
@@ -405,7 +602,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
     *Mario Schüttel*
 
 * Improve feature parity with Rails translations
-  * Don't create a translation backend if the component has no translation file
+  * Don't create a translation back end if the component has no translation file
   * Mark translation keys ending with `html` as HTML-safe
   * Always convert keys to String
   * Support multiple keys
@@ -447,7 +644,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
     *Alex Robbin, Blake Williams*
 
-* Experimental: call `._sidecar_files` to fetch the sidecar files for a given list of extensions, e.g. passing `["yml", "yaml"]`.
+* Experimental: call `._sidecar_files` to fetch the sidecar files for a given list of extensions, for example passing `["yml", "yaml"]`.
 
     *Elia Schito*
 
@@ -487,11 +684,11 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## 2.26.0
 
-* Lazily evaluate component `content` in `render?`, preventing the `content` block from being evaluated when `render?` returns false.
+* Delay evaluating component `content` in `render?`, preventing the `content` block from being evaluated when `render?` returns false.
 
     *Blake Williams*
 
-* Do not generate template when using `--inline` flag.
+* Don't generate template when using `--inline` flag.
 
     *Hans Lemuet*
 
@@ -552,7 +749,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
   * `with_slot collection: true` becomes `renders_many`.
   * Slot definitions now accept either a component class, component class name, or a lambda instead of a `class_name:` keyword argument.
   * Slots now support positional arguments.
-  * Slots no longer use the `content` attribute to render content, instead relying on `to_s`. e.g. `<%= my_slot %>`.
+  * Slots no longer use the `content` attribute to render content, instead relying on `to_s`. for example `<%= my_slot %>`.
   * Slot values are no longer set via the `slot` method, and instead use the name of the slot.
 
     *Blake Williams*
@@ -615,7 +812,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## 2.18.2
 
-* Raise an error if controller or view context is accessed during initialize as they are only available in render.
+* Raise an error if controller or view context is accessed during initialize as they're only available in render.
 
     *Julian Nadeau*
 
@@ -631,7 +828,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## 2.18.0
 
-* Fix auto-loading of previews (changes no longer require a server restart)
+* Fix auto loading of previews (changes no longer require a server restart)
 
     *Matt Brictson*
 
@@ -724,7 +921,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## 2.10.0
 
-* Raise an `ArgumentError` with a helpful message when Ruby cannot parse a component class.
+* Raise an `ArgumentError` with a helpful message when Ruby can't parse a component class.
 
     *Max Beizer*
 
@@ -816,7 +1013,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## v2.2.1
 
-* Fix bug where template could not be found if `inherited` was redefined.
+* Fix bug where template couldn't be found if `inherited` was redefined.
 
     *Joel Hawksley*
 
@@ -832,7 +1029,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 ## v2.1.0
 
-* Support rendering collections (e.g., `render(MyComponent.with_collection(@items))`).
+* Support rendering collections (for example, `render(MyComponent.with_collection(@items))`).
 
     *Tim Clem*
 
@@ -854,7 +1051,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
     *Andrew Mason*
 
-* ViewComponent generators do not not prompt for content requirement.
+* ViewComponent generators don't not prompt for content requirement.
 
     *Joel Hawksley*
 
@@ -976,7 +1173,7 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
     *Jon Palmer*
 
-* Add `#render?` hook to easily allow components to be no-ops.
+* Add `#render?` hook to allow components to be no-ops.
 
     *Kyle Fox*
 
@@ -1044,7 +1241,9 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 * Fix edge case issue with extracting variants from less conventional source_locations.
 
+<!-- vale proselint.GenderBias = NO -->
     *Ryan Workman*
+<!-- vale proselint.GenderBias = YES -->
 
 ## v1.6.0
 
@@ -1080,7 +1279,9 @@ _Note: This release includes an underlying change to Slots that may affect incor
 
 * Add support for RSpec to generators.
 
+<!-- vale proselint.GenderBias = NO -->
     *Dylan Clark, Ryan Workman*
+<!-- vale proselint.GenderBias = YES -->
 
 * Require controllers as part of setting autoload paths.
 
@@ -1104,7 +1305,9 @@ Note: `actionview-component` is now loaded by requiring `actionview/component`,
 
 * Fix issue with generating component method signatures.
 
+<!-- vale proselint.GenderBias = NO -->
     *Ryan Workman, Dylan Clark*
+<!-- vale proselint.GenderBias = YES -->
 
 * Create component generator.
 
@@ -1176,7 +1379,7 @@ Note: `actionview-component` is now loaded by requiring `actionview/component`,
 
 ## v1.3.3
 
-* Do not raise error when sidecar files that are not templates exist.
+* Don't raise error when sidecar files that aren't templates exist.
 
     *Joel Hawksley*
 

data/lib/rails/generators/abstract_generator.rb

@@ -15,7 +15,7 @@ module ViewComponent
     end
 
     def destination_directory
-      if options["sidecar"]
+      if sidecar?
         File.join(component_path, class_path, destination_file_name)
       else
         File.join(component_path, class_path)
@@ -42,5 +42,9 @@ module ViewComponent
           gsub("/", "--")
       end
     end
+
+    def sidecar?
+      options["sidecar"] || ViewComponent::Base.generate_sidecar
+    end
   end
 end

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

@@ -15,6 +15,7 @@ module Rails
       class_option :parent, type: :string, desc: "The parent class for the generated component"
       class_option :stimulus, type: :boolean, default: ViewComponent::Base.generate_stimulus_controller
       class_option :sidecar, type: :boolean, default: false
+      class_option :locale, type: :boolean, default: ViewComponent::Base.generate_locale
 
       def create_component_file
         template "component.rb", File.join(component_path, class_path, "#{file_name}_component.rb")
@@ -26,6 +27,8 @@ module Rails
 
       hook_for :stimulus, type: :boolean
 
+      hook_for :locale, type: :boolean
+
       hook_for :template_engine do |instance, template_engine|
         instance.invoke template_engine, [instance.name]
       end

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

@@ -6,7 +6,7 @@ class <%= class_name %>Component < <%= parent_class %>
     <%= initialize_body %>
   end
 <%- end -%>
-<%- if initialize_call_method_for_inline? -%>  
+<%- if initialize_call_method_for_inline? -%>
   def call
     content_tag :h1, "Hello world!"<%= ", data: { controller: \"#{stimulus_controller}\" }" if options["stimulus"] %>
   end

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

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+
+require "rails/generators/abstract_generator"
+
+module Locale
+  module Generators
+    class ComponentGenerator < ::Rails::Generators::NamedBase
+      include ViewComponent::AbstractGenerator
+
+      source_root File.expand_path("templates", __dir__)
+      argument :attributes, type: :array, default: [], banner: "attribute"
+      class_option :sidecar, type: :boolean, default: false
+
+      def create_locale_file
+        if ViewComponent::Base.generate_distinct_locale_files
+          I18n.available_locales.each do |locale|
+            create_file destination(locale), translations_hash([locale]).to_yaml
+          end
+        else
+          create_file destination, translations_hash(I18n.available_locales).to_yaml
+        end
+      end
+
+      private
+
+      def translations_hash(locales = [:en])
+        locales.map { |locale| [locale.to_s, translation_keys] }.to_h
+      end
+
+      def translation_keys
+        keys = attributes.map(&:name)
+        keys = %w[hello] if keys.empty?
+        keys.map { |name| [name, name.capitalize] }.to_h
+      end
+
+      def destination(locale = nil)
+        extention = ".#{locale}" if locale
+        if sidecar?
+          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component#{extention}.yml")
+        else
+          File.join(component_path, class_path, "#{file_name}_component#{extention}.yml")
+        end
+      end
+    end
+  end
+end

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

@@ -23,7 +23,7 @@ module Stimulus
       private
 
       def destination
-        if options["sidecar"]
+        if sidecar?
           File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component_controller.js")
         else
           File.join(component_path, class_path, "#{file_name}_component_controller.js")

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

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "rails/generators/erb/component_generator"
+
+module Tailwindcss
+  module Generators
+    class ComponentGenerator < Erb::Generators::ComponentGenerator
+      source_root File.expand_path("templates", __dir__)
+    end
+  end
+end

data/lib/rails/generators/tailwindcss/templates/component.html.erb.tt

@@ -0,0 +1 @@
+<div<%= data_attributes %>>Add <%= class_name %> template here</div>

data/lib/view_component/base.rb

@@ -152,7 +152,7 @@ module ViewComponent
       if view_context.nil?
         raise(
           ViewContextCalledBeforeRenderError,
-          "`#controller` cannot be used during initialization, as it depends " \
+          "`#controller` can't be used during initialization, 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 " \
@@ -171,7 +171,7 @@ module ViewComponent
       if view_context.nil?
         raise(
           ViewContextCalledBeforeRenderError,
-          "`#helpers` cannot be used during initialization, as it depends " \
+          "`#helpers` can't be used during initialization, 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 " \
@@ -206,7 +206,7 @@ module ViewComponent
     #
     # @private
     def format
-      # Ruby 2.6 throws a warning without checking `defined?`, 2.7 does not
+      # Ruby 2.6 throws a warning without checking `defined?`, 2.7 doesn't
       if defined?(@__vc_variant)
         @__vc_variant
       end
@@ -279,11 +279,31 @@ module ViewComponent
     #
     mattr_accessor :generate_stimulus_controller, instance_writer: false, default: false
 
+    # Always generate translations file alongside the component:
+    #
+    #     config.view_component.generate_locale = true
+    #
+    # Defaults to `false`.
+    #
+    mattr_accessor :generate_locale, instance_writer: false, default: false
+
+    # Always generate as many translations files as available locales:
+    #
+    #     config.view_component.generate_distinct_locale_files = true
+    #
+    # Defaults to `false`.
+    #
+    # One file will be generated for each configured `I18n.available_locales`.
+    # Fallback on `[:en]` when no available_locales is defined.
+    #
+    mattr_accessor :generate_distinct_locale_files, instance_writer: false, default: false
+
     # Path for component files
     #
     #     config.view_component.view_component_path = "app/my_components"
     #
-    # Defaults to "app/components".
+    # Defaults to `app/components`.
+    #
     mattr_accessor :view_component_path, instance_writer: false, default: "app/components"
 
     # Parent class for generated components
@@ -291,8 +311,16 @@ module ViewComponent
     #     config.view_component.component_parent_class = "MyBaseComponent"
     #
     # Defaults to "ApplicationComponent" if defined, "ViewComponent::Base" otherwise.
-    mattr_accessor :component_parent_class,
-                   instance_writer: false
+    #
+    mattr_accessor :component_parent_class, instance_writer: false
+
+    # Always generate a component with a sidecar directory:
+    #
+    #     config.view_component.generate_sidecar = true
+    #
+    # Defaults to `false`.
+    #
+    mattr_accessor :generate_sidecar, instance_writer: false, default: false
 
     class << self
       # @private
@@ -318,7 +346,7 @@ module ViewComponent
 
         # Add support for nested components defined in the same file.
         #
-        # e.g.
+        # for example
         #
         # class MyComponent < ViewComponent::Base
         #   class MyOtherComponent < ViewComponent::Base
@@ -431,7 +459,7 @@ module ViewComponent
       end
 
       # Ensure the component initializer accepts the
-      # collection parameter. By default, we do not
+      # collection parameter. By default, we don't
       # validate that the default parameter name
       # is accepted, as support for collection
       # rendering is optional.
@@ -442,7 +470,7 @@ module ViewComponent
         return unless parameter
         return if initialize_parameter_names.include?(parameter)
 
-        # If Ruby cannot parse the component class, then the initalize
+        # If Ruby can't parse the component class, then the initalize
         # parameters will be empty and ViewComponent will not be able to render
         # the component.
         if initialize_parameters.empty?
@@ -455,14 +483,14 @@ module ViewComponent
         end
 
         raise ArgumentError.new(
-          "The initializer for #{self} does not accept the parameter `#{parameter}`, " \
+          "The initializer for #{self} doesn't accept the parameter `#{parameter}`, " \
           "which is required in order to render it as a collection.\n\n" \
           "To fix this issue, update the initializer to accept `#{parameter}`.\n\n" \
           "See https://viewcomponent.org/guide/collections.html for more information on rendering collections."
         )
       end
 
-      # Ensure the component initializer does not define
+      # Ensure the component initializer doesn't define
       # invalid parameters that could override the framework's
       # methods.
       # @private TODO: add documentation
@@ -470,7 +498,7 @@ module ViewComponent
         return unless initialize_parameter_names.include?(RESERVED_PARAMETER)
 
         raise ViewComponent::ComponentError.new(
-          "#{self} initializer cannot accept the parameter `#{RESERVED_PARAMETER}`, as it will override a " \
+          "#{self} initializer can't accept the parameter `#{RESERVED_PARAMETER}`, as it will override a " \
           "public ViewComponent method. To fix this issue, rename the parameter."
         )
       end
@@ -507,6 +535,10 @@ module ViewComponent
       private
 
       def initialize_parameter_names
+        return attribute_names.map(&:to_sym) if respond_to?(:attribute_names)
+
+        return attribute_types.keys.map(&:to_sym) if Rails::VERSION::MAJOR <= 5 && respond_to?(:attribute_types)
+
         initialize_parameters.map(&:last)
       end
 

data/lib/view_component/collection.rb

@@ -4,20 +4,34 @@ require "action_view/renderer/collection_renderer" if Rails.version.to_f >= 6.1
 
 module ViewComponent
   class Collection
+    include Enumerable
     attr_reader :component
 
     delegate :format, to: :component
+    delegate :size, to: :@collection
 
     def render_in(view_context, &block)
+      components.map do |component|
+        component.render_in(view_context, &block)
+      end.join.html_safe # rubocop:disable Rails/OutputSafety
+    end
+
+    def components
+      return @components if defined? @components
+
       iterator = ActionView::PartialIteration.new(@collection.size)
 
       component.validate_collection_parameter!(validate_default: true)
 
-      @collection.map do |item|
-        content = component.new(**component_options(item, iterator)).render_in(view_context, &block)
-        iterator.iterate!
-        content
-      end.join.html_safe # rubocop:disable Rails/OutputSafety
+      @components = @collection.map do |item|
+        component.new(**component_options(item, iterator)).tap do |component|
+          iterator.iterate!
+        end
+      end
+    end
+
+    def each(&block)
+      components.each(&block)
     end
 
     private
@@ -42,7 +56,7 @@ module ViewComponent
     def component_options(item, iterator)
       item_options = { component.collection_parameter => item }
       item_options[component.collection_counter_parameter] = iterator.index + 1 if component.counter_argument_present?
-      item_options[component.collection_iteration_parameter] = iterator if component.iteration_argument_present?
+      item_options[component.collection_iteration_parameter] = iterator.dup if component.iteration_argument_present?
 
       @options.merge(item_options)
     end

data/lib/view_component/compile_cache.rb

@@ -2,7 +2,7 @@
 
 module ViewComponent
   # Keeps track of which templates have already been compiled
-  # This is not part of the public API
+  # This isn't part of the public API
   module CompileCache
     mattr_accessor :cache, instance_reader: false, instance_accessor: false do
       Set.new
@@ -18,6 +18,10 @@ module ViewComponent
       cache.include? klass
     end
 
+    def invalidate_class!(klass)
+      cache.delete(klass)
+    end
+
     def invalidate!
       cache.clear
     end

data/lib/view_component/compiler.rb

@@ -2,66 +2,95 @@
 
 module ViewComponent
   class Compiler
+    # Lock required to be obtained before compiling the component
+    attr_reader :__vc_compiler_lock
+
+    # Compiler mode. Can be either:
+    # * development (a blocking mode which ensures thread safety when redefining the `call` method for components,
+    #                default in Rails development and test mode)
+    # * production (a non-blocking mode, default in Rails production mode)
+    DEVELOPMENT_MODE = :development
+    PRODUCTION_MODE = :production
+
+    class_attribute :mode, default: PRODUCTION_MODE
+
     def initialize(component_class)
       @component_class = component_class
+      @__vc_compiler_lock = Monitor.new
     end
 
     def compiled?
       CompileCache.compiled?(component_class)
     end
 
+    def development?
+      self.class.mode == DEVELOPMENT_MODE
+    end
+
     def compile(raise_errors: false)
       return if compiled?
 
-      subclass_instance_methods = component_class.instance_methods(false)
+      with_lock do
+        CompileCache.invalidate_class!(component_class)
 
-      if subclass_instance_methods.include?(:with_content) && raise_errors
-        raise ViewComponent::ComponentError.new(
-          "#{component_class} implements a reserved method, `#with_content`.\n\n" \
-          "To fix this issue, change the name of the method."
-        )
-      end
-
-      if template_errors.present?
-        raise ViewComponent::TemplateError.new(template_errors) if raise_errors
+        subclass_instance_methods = component_class.instance_methods(false)
 
-        return false
-      end
+        if subclass_instance_methods.include?(:with_content) && raise_errors
+          raise ViewComponent::ComponentError.new(
+            "#{component_class} implements a reserved method, `#with_content`.\n\n" \
+            "To fix this issue, change the name of the method."
+          )
+        end
 
-      if subclass_instance_methods.include?(:before_render_check)
-        ActiveSupport::Deprecation.warn(
-          "`#before_render_check` will be removed in v3.0.0.\n\n" \
-          "To fix this issue, use `#before_render` instead."
-        )
-      end
+        if template_errors.present?
+          raise ViewComponent::TemplateError.new(template_errors) if raise_errors
 
-      if raise_errors
-        component_class.validate_initialization_parameters!
-        component_class.validate_collection_parameter!
-      end
+          return false
+        end
 
-      templates.each do |template|
-        # Remove existing compiled template methods,
-        # as Ruby warns when redefining a method.
-        method_name = call_method_name(template[:variant])
+        if subclass_instance_methods.include?(:before_render_check)
+          ActiveSupport::Deprecation.warn(
+            "`#before_render_check` will be removed in v3.0.0.\n\n" \
+            "To fix this issue, use `#before_render` instead."
+          )
+        end
 
-        if component_class.instance_methods.include?(method_name.to_sym)
-          component_class.send(:undef_method, method_name.to_sym)
+        if raise_errors
+          component_class.validate_initialization_parameters!
+          component_class.validate_collection_parameter!
         end
 
-        component_class.class_eval <<-RUBY, template[:path], -1
+        templates.each do |template|
+          # Remove existing compiled template methods,
+          # as Ruby warns when redefining a method.
+          method_name = call_method_name(template[:variant])
+
+          if component_class.instance_methods.include?(method_name.to_sym)
+            component_class.send(:undef_method, method_name.to_sym)
+          end
+
+          component_class.class_eval <<-RUBY, template[:path], -1
           def #{method_name}
             @output_buffer = ActionView::OutputBuffer.new
             #{compiled_template(template[:path])}
           end
-        RUBY
-      end
+          RUBY
+        end
+
+        define_render_template_for
 
-      define_render_template_for
+        component_class._after_compile
 
-      component_class._after_compile
+        CompileCache.register(component_class)
+      end
+    end
 
-      CompileCache.register(component_class)
+    def with_lock(&block)
+      if development?
+        __vc_compiler_lock.synchronize(&block)
+      else
+        block.call
+      end
     end
 
     private
@@ -77,16 +106,30 @@ module ViewComponent
         "elsif variant.to_sym == :#{variant}\n    #{call_method_name(variant)}"
       end.join("\n")
 
-      component_class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+      body = <<-RUBY
+        if variant.nil?
+          call
+        #{variant_elsifs}
+        else
+          call
+        end
+      RUBY
+
+      if development?
+        component_class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
         def render_template_for(variant = nil)
-          if variant.nil?
-            call
-          #{variant_elsifs}
-          else
-            call
+          self.class.compiler.with_lock do
+            #{body}
           end
         end
-      RUBY
+        RUBY
+      else
+        component_class.class_eval <<-RUBY, __FILE__, __LINE__ + 1
+        def render_template_for(variant = nil)
+          #{body}
+        end
+        RUBY
+      end
     end
 
     def template_errors
@@ -95,7 +138,7 @@ module ViewComponent
           errors = []
 
           if (templates + inline_calls).empty?
-            errors << "Could not find a template file or inline render method for #{component_class}."
+            errors << "Couldn't find a template file or inline render method for #{component_class}."
           end
 
           if templates.count { |template| template[:variant].nil? } > 1

data/lib/view_component/engine.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "rails"
-require "view_component"
 
 module ViewComponent
   class Engine < Rails::Engine # :nodoc:
@@ -116,6 +115,14 @@ module ViewComponent
       end
     end
 
+    initializer "compiler mode" do |app|
+      ViewComponent::Compiler.mode = if Rails.env.development? || Rails.env.test?
+                                       ViewComponent::Compiler::DEVELOPMENT_MODE
+                                     else
+                                       ViewComponent::Compiler::PRODUCTION_MODE
+                                     end
+    end
+
     config.after_initialize do |app|
       options = app.config.view_component
 
@@ -145,3 +152,14 @@ module ViewComponent
     end
   end
 end
+
+# :nocov:
+unless defined?(ViewComponent::Base)
+  ActiveSupport::Deprecation.warn(
+    "This manually engine loading is deprecated and will be removed in v3.0.0. " \
+    "Remove `require \"view_component/engine\"`."
+  )
+
+  require "view_component"
+end
+# :nocov:

data/lib/view_component/preview.rb

@@ -80,7 +80,7 @@ module ViewComponent # :nodoc:
         if preview_path.nil?
           raise(
             PreviewTemplateError,
-            "A preview template for example #{example} does not exist.\n\n" \
+            "A preview template for example #{example} doesn't exist.\n\n" \
             "To fix this issue, create a template for the example."
           )
         end

data/lib/view_component/slot_v2.rb

@@ -20,7 +20,7 @@ module ViewComponent
     # component, or a function that returns a component, we render that
     # component instance, returning the string.
     #
-    # If the slot renderable is a function and returns a string, it is
+    # If the slot renderable is a function and returns a string, it's
     # set as `@__vc_content` and is returned directly.
     #
     # If there is no slot renderable, we evaluate the block passed to
@@ -40,6 +40,8 @@ module ViewComponent
 
       @content =
         if defined?(@__vc_component_instance)
+          @__vc_component_instance.__vc_original_view_context = @parent.__vc_original_view_context
+
           if defined?(@__vc_content_set_by_with_content)
             @__vc_component_instance.with_content(@__vc_content_set_by_with_content)
 
@@ -69,7 +71,7 @@ module ViewComponent
 
     # Allow access to public component methods via the wrapper
     #
-    # e.g.
+    # for example
     #
     # calling `header.name` (where `header` is a slot) will call `name`
     # on the `HeaderComponent` instance.

data/lib/view_component/slotable.rb

@@ -29,12 +29,12 @@ module ViewComponent
         )
 
         slot_names.each do |slot_name|
-          # Ensure slot_name is not already declared
+          # Ensure slot_name isn't already declared
           if self.slots.key?(slot_name)
             raise ArgumentError.new("#{slot_name} slot declared multiple times")
           end
 
-          # Ensure slot name is not :content
+          # Ensure slot name isn't :content
           if slot_name == :content
             raise ArgumentError.new ":content is a reserved slot name. Please use another name, such as ':body'"
           end
@@ -105,7 +105,7 @@ module ViewComponent
     # <% end %>
     #
     def slot(slot_name, **args, &block)
-      # Raise ArgumentError if `slot` does not exist
+      # Raise ArgumentError if `slot` doesn't exist
       unless slots.keys.include?(slot_name)
         raise ArgumentError.new "Unknown slot '#{slot_name}' - expected one of '#{slots.keys}'"
       end
@@ -140,7 +140,7 @@ module ViewComponent
         instance_variable_set(slot[:instance_variable_name], slot_instance)
       end
 
-      # Return nil, as this method should not output anything to the view itself.
+      # Return nil, as this method shouldn't output anything to the view itself.
       nil
     end
   end

data/lib/view_component/slotable_v2.rb

@@ -121,7 +121,7 @@ module ViewComponent
         singular_name = ActiveSupport::Inflector.singularize(slot_name)
 
         # Define setter for singular names
-        # e.g. `renders_many :items` allows fetching all tabs with
+        # for example `renders_many :items` allows fetching all tabs with
         # `component.tabs` and setting a tab with `component.tab`
         define_method singular_name do |*args, &block|
           set_slot(slot_name, nil, *args, &block)
@@ -181,7 +181,7 @@ module ViewComponent
           # If callable is a string, we assume it's referencing an internal class
           slot[:renderable_class_name] = callable
         elsif callable.respond_to?(:call)
-          # If slot does not respond to `render_in`, we assume it's a proc,
+          # If slot doesn't respond to `render_in`, we assume it's a proc,
           # define a method, and save a reference to it to call when setting
           method_name = :"_call_#{slot_name}"
           define_method method_name, &callable
@@ -256,7 +256,7 @@ module ViewComponent
       # 1. If this is a `content_area` style sub-component, we will render the
       # block via the `slot`
       #
-      # 2. Since we have to pass block content to components when calling
+      # 2. Since we've to pass block content to components when calling
       # `render`, evaluating the block here would require us to call
       # `view_context.capture` twice, which is slower
       slot.__vc_content_block = block if block_given?

data/lib/view_component/test_helpers.rb

@@ -38,7 +38,7 @@ module ViewComponent
     # assert_text("Hello, World!")
     # ```
     #
-    # @param component [ViewComponent::Base] The instance of the component to be rendered.
+    # @param component [ViewComponent::Base, ViewComponent::Collection] The instance of the component to be rendered.
     # @return [Nokogiri::HTML]
     def render_inline(component, **args, &block)
       @rendered_component =
@@ -103,7 +103,7 @@ module ViewComponent
       @controller = old_controller
     end
 
-    # Set the URL for the current request (such as when using request-dependent path helpers):
+    # Set the URL of the current request (such as when using request-dependent path helpers):
     #
     # ```ruby
     # with_request_url("/users/42") do
@@ -113,16 +113,22 @@ module ViewComponent
     #
     # @param path [String] The path to set for the current request.
     def with_request_url(path)
+      old_request_path_info = request.path_info
       old_request_path_parameters = request.path_parameters
       old_request_query_parameters = request.query_parameters
+      old_request_query_string = request.query_string
       old_controller = defined?(@controller) && @controller
 
+      request.path_info = path
       request.path_parameters = Rails.application.routes.recognize_path(path)
       request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_query(path.split("?")[1]))
+      request.set_header(Rack::QUERY_STRING, path.split("?")[1])
       yield
     ensure
+      request.path_info = old_request_path_info
       request.path_parameters = old_request_path_parameters
       request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)
+      request.set_header(Rack::QUERY_STRING, old_request_query_string)
       @controller = old_controller
     end
 

data/lib/view_component/version.rb

@@ -3,7 +3,7 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 44
+    MINOR = 48
     PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")

data/lib/view_component.rb

@@ -19,4 +19,13 @@ module ViewComponent
   autoload :Translatable
 end
 
-require "view_component/engine" if defined?(Rails::Engine)
+# :nocov:
+if defined?(ViewComponent::Engine)
+  ActiveSupport::Deprecation.warn(
+    "This manually engine loading is deprecated and will be removed in v3.0.0. " \
+    "Remove `require \"view_component/engine\"`."
+  )
+elsif defined?(Rails::Engine)
+  require "view_component/engine"
+end
+# :nocov:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.44.0
+  version: 2.48.0
 platform: ruby
 authors:
 - GitHub Open Source
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-11-18 00:00:00.000000000 Z
+date: 2022-01-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,6 +44,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.4'
 - !ruby/object:Gem::Dependency
   name: benchmark-ips
   requirement: !ruby/object:Gem::Requirement
@@ -268,7 +282,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: 
+description:
 email:
 - opensource+view_component@github.com
 executables: []
@@ -295,6 +309,7 @@ files:
 - lib/rails/generators/erb/templates/component.html.erb.tt
 - lib/rails/generators/haml/component_generator.rb
 - lib/rails/generators/haml/templates/component.html.haml.tt
+- lib/rails/generators/locale/component_generator.rb
 - lib/rails/generators/preview/component_generator.rb
 - lib/rails/generators/preview/templates/component_preview.rb.tt
 - lib/rails/generators/rspec/component_generator.rb
@@ -303,6 +318,8 @@ files:
 - lib/rails/generators/slim/templates/component.html.slim.tt
 - lib/rails/generators/stimulus/component_generator.rb
 - lib/rails/generators/stimulus/templates/component_controller.js.tt
+- lib/rails/generators/tailwindcss/component_generator.rb
+- lib/rails/generators/tailwindcss/templates/component.html.erb.tt
 - lib/rails/generators/test_unit/component_generator.rb
 - lib/rails/generators/test_unit/templates/component_test.rb.tt
 - lib/view_component.rb
@@ -341,7 +358,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -356,8 +373,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.2
-signing_key: 
+rubygems_version: 3.1.4
+signing_key:
 specification_version: 4
 summary: View components for Rails
 test_files: []