view_component 2.43.1 → 2.47.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68e0fc06b5f3e59c4baf241bef8827bb6d917823ee7d79052ff7e2e9406363da
-  data.tar.gz: a21f0dabe952531d817fdd6b3859089e4a21bd3f7474bdaee6c6b5953a653593
+  metadata.gz: 2c94e6fdeccccb7180494d100eef8c78a8dc8e3e9bc30e5647017b440788c6eb
+  data.tar.gz: c3836df9c15e8039ba673895ad5a9544aebe55325f9fbd418b96f4bb4238b8d6
 SHA512:
-  metadata.gz: 7c8068857218b70cba3d99fe04df088ab2bb0da3f03f9277352b7a96dcebaff10fcf0d1b3657004ca5d6552c2033173a599fd64ce81b1e5635db224d48617d51
-  data.tar.gz: e7808192370b1c9f3eb4af84def46ebbfc4828b23f4c75be2f4753b18463f733beff77fff65ba3ccaa690efb6365fa5dcab574b962f905deb1cfbd4475dc3f20
+  metadata.gz: 644f964985c8418371fdcac45e1e7b1771d89ee65ed8a692ec51c50cbed8a578937ba1bb7b9bf1d3b3e3729bd418df5fb2e9d1aee3bbb8215bfbed4504457074
+  data.tar.gz: c4df9e14be4dc20e529beb794c96baf424087f7e36423b301402325e1b1ce0ae8ab575fe1b69334b3e27b5fa9e2fee227e9bd20e0e99fe5f384f2f535b43f80c

data/README.md

@@ -1,4 +1,5 @@
-<img src="/docs/logo/viewcomponent-color-logo.svg" alt="ViewComponent logo" width="500">
+![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,191 @@ title: Changelog
 
 ## main
 
+## 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 docs 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*
+
+## 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.
+
+    *Joel Hawksley*, *Blake Williams*, *Cameron Dutro*
+
+* Add Github repo link to docs website header.
+
+    *Hans Lemuet*
+
+* Change logo in README for dark theme readability.
+
+    *Dylan Smith*
+
+* Add Litmus to users list.
+
+    *Dylan Smith*
+
+* Add @dylanatsmith as codeowner of the ViewComponent logo and member of committers team.
+
+    *Joel Hawksley*
+
+* Autoload `CompileCache`, which is optionally called in `engine.rb`.
+
+    *Gregory Igelmund*
+
+* Move frequently asked questions to other pages, add History page.
+
+    *Joel Hawksley*
+
+* Fix typo.
+
+    *James Hart*
+
+* Add `require "method_source"` if it options.show_previews_source is enabled.
+
+    *Yoshiyuki Hirano*
+
+* Move show_previews_source definition to Previewable.
+
+    *Yoshiyuki Hirano*
+
+* Clear cache in MethodSource to apply the change odf preview code without app server restart.
+
+    *Yoshiyuki Hirano*
+
 ## 2.43.1
 
 * Remove unnecessary call to `ruby2_keywords` for polymorphic slot getters.
@@ -96,7 +281,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*
 
@@ -300,7 +485,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*
 
@@ -348,7 +533,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.
 
@@ -359,7 +544,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
@@ -401,7 +586,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*
 
@@ -441,11 +626,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*
 
@@ -506,7 +691,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*
@@ -569,7 +754,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*
 
@@ -585,7 +770,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*
 
@@ -678,7 +863,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*
 
@@ -770,7 +955,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*
 
@@ -786,7 +971,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*
 
@@ -808,7 +993,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*
 
@@ -930,7 +1115,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*
 
@@ -998,7 +1183,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
 
@@ -1034,7 +1221,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.
 
@@ -1058,7 +1247,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.
 
@@ -1130,7 +1321,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/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 options["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/view_component/base.rb

@@ -29,7 +29,7 @@ module ViewComponent
     class_attribute :content_areas
     self.content_areas = [] # class_attribute:default doesn't work until Rails 5.2
 
-    attr_accessor :original_view_context
+    attr_accessor :__vc_original_view_context
 
     # EXPERIMENTAL: This API is experimental and may be removed at any time.
     # Hook for allowing components to do work as part of the compilation process.
@@ -52,7 +52,7 @@ module ViewComponent
       self.class.compile(raise_errors: true)
 
       @view_context = view_context
-      self.original_view_context ||= view_context
+      self.__vc_original_view_context ||= view_context
 
       @lookup_context ||= view_context.lookup_context
 
@@ -137,10 +137,10 @@ module ViewComponent
     # @private
     def render(options = {}, args = {}, &block)
       if options.is_a? ViewComponent::Base
-        options.original_view_context = original_view_context
+        options.__vc_original_view_context = __vc_original_view_context
         super
       else
-        original_view_context.render(options, args, &block)
+        __vc_original_view_context.render(options, args, &block)
       end
     end
 
@@ -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 " \
@@ -186,7 +186,7 @@ module ViewComponent
       #
       # This allows ivars to remain persisted when using the same helper via
       # `helpers` across multiple components and partials.
-      @__vc_helpers ||= original_view_context || controller.view_context
+      @__vc_helpers ||= __vc_original_view_context || controller.view_context
     end
 
     # Exposes .virtual_path as an instance method
@@ -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
@@ -271,27 +271,38 @@ module ViewComponent
     #
     mattr_accessor :render_monkey_patch_enabled, instance_writer: false, default: true
 
-    # Enable or disable source code previews in component previews:
+    # Always generate a Stimulus controller alongside the component:
     #
-    #     config.view_component.show_previews_source = true
+    #     config.view_component.generate_stimulus_controller = true
     #
     # Defaults to `false`.
     #
-    mattr_accessor :show_previews_source, instance_writer: false, default: false
+    mattr_accessor :generate_stimulus_controller, instance_writer: false, default: false
 
-    # Always generate a Stimulus controller alongside the component:
+    # Always generate translations file alongside the component:
     #
-    #     config.view_component.generate_stimulus_controller = true
+    #     config.view_component.generate_locale = true
     #
     # Defaults to `false`.
     #
-    mattr_accessor :generate_stimulus_controller, instance_writer: false, default: 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
@@ -326,7 +337,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
@@ -439,7 +450,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.
@@ -450,7 +461,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?
@@ -463,14 +474,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
@@ -478,7 +489,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
@@ -515,6 +526,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/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,8 +2,12 @@
 
 module ViewComponent
   class Compiler
+    # Lock required to be obtained before compiling the component
+    attr_reader :__vc_compiler_lock
+
     def initialize(component_class)
       @component_class = component_class
+      @__vc_compiler_lock = Monitor.new
     end
 
     def compiled?
@@ -13,55 +17,59 @@ module ViewComponent
     def compile(raise_errors: false)
       return if compiled?
 
-      subclass_instance_methods = component_class.instance_methods(false)
+      __vc_compiler_lock.synchronize 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
+        subclass_instance_methods = component_class.instance_methods(false)
 
-      if template_errors.present?
-        raise ViewComponent::TemplateError.new(template_errors) if raise_errors
-
-        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
-          def #{method_name}
-            @output_buffer = ActionView::OutputBuffer.new
-            #{compiled_template(template[:path])}
+        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
-        RUBY
-      end
 
-      define_render_template_for
+          component_class.class_eval <<-RUBY, template[:path], -1
+            def #{method_name}
+              @output_buffer = ActionView::OutputBuffer.new
+              #{compiled_template(template[:path])}
+            end
+          RUBY
+        end
+
+        define_render_template_for
 
-      component_class._after_compile
+        component_class._after_compile
 
-      CompileCache.register(component_class)
+        CompileCache.register(component_class)
+      end
     end
 
     private
@@ -95,7 +103,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:
@@ -17,6 +16,7 @@ module ViewComponent
 
       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?
+      options.show_previews_source ||= ViewComponent::Base.show_previews_source
       options.instrumentation_enabled = false if options.instrumentation_enabled.nil?
       options.preview_route ||= ViewComponent::Base.preview_route
       options.preview_controller ||= ViewComponent::Base.preview_controller
@@ -32,6 +32,14 @@ module ViewComponent
           )
           options.preview_paths << options.preview_path
         end
+
+        if options.show_previews_source
+          require "method_source"
+
+          app.config.to_prepare do
+            MethodSource.instance_variable_set(:@lines_for_file, {})
+          end
+        end
       end
 
       ActiveSupport.on_load(:view_component) do
@@ -136,3 +144,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/previewable.rb

@@ -15,6 +15,14 @@ module ViewComponent
       #
       mattr_accessor :show_previews, instance_writer: false
 
+      # Enable or disable source code previews in component previews:
+      #
+      #     config.view_component.show_previews_source = true
+      #
+      # Defaults to `false`.
+      #
+      mattr_accessor :show_previews_source, instance_writer: false, default: false
+
       # Set a custom default layout used for preview index and individual previews:
       #
       #     config.view_component.default_preview_layout = "component_preview"

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

@@ -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

data/lib/view_component/version.rb

@@ -3,8 +3,8 @@
 module ViewComponent
   module VERSION
     MAJOR = 2
-    MINOR = 43
-    PATCH = 1
+    MINOR = 47
+    PATCH = 0
 
     STRING = [MAJOR, MINOR, PATCH].join(".")
   end

data/lib/view_component.rb

@@ -8,6 +8,7 @@ module ViewComponent
 
   autoload :Base
   autoload :Compiler
+  autoload :CompileCache
   autoload :ComponentError
   autoload :Instrumentation
   autoload :Preview
@@ -18,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.43.1
+  version: 2.47.0
 platform: ruby
 authors:
 - GitHub Open Source
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-11-09 00:00:00.000000000 Z
+date: 2021-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -76,16 +76,16 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 1.15.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.2'
+        version: 1.15.0
 - !ruby/object:Gem::Dependency
   name: erb_lint
   requirement: !ruby/object:Gem::Requirement
@@ -268,7 +268,7 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description:
+description: 
 email:
 - opensource+view_component@github.com
 executables: []
@@ -295,6 +295,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
@@ -341,7 +342,7 @@ licenses:
 - MIT
 metadata:
   allowed_push_host: https://rubygems.org
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -356,8 +357,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
-signing_key:
+rubygems_version: 3.1.2
+signing_key: 
 specification_version: 4
 summary: View components for Rails
 test_files: []