view_component 3.12.1 → 3.23.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 875f47469a83b3b70de2e4271cc4af72542d88c6e12c373c8f6912d3c8c6d13e
-  data.tar.gz: 161671b627c087f227706c10e6ca7f900dcdd3d2ea49232024543bf78a3be14b
+  metadata.gz: 79672f93bd1c3bfa2dae00890f833c5dfb63dec49585dd79453f6592f9f47520
+  data.tar.gz: e6fe55dfe963ce0e7f4d793c93b67aefa92c99ee834c17c35644a9ea8b746886
 SHA512:
-  metadata.gz: aaa215e2aba616eca2ea0e1bd1e4ab76df2f6f4f34d1f3f225a5802a943b8e6c8e920b3821fda06353e52979345a8d941c2d3d2eaa24b71a6928502846224acc
-  data.tar.gz: f7da13dfa835866ac685d567f41549857ca40682e6f2beee269bf07b4b9bfaf942af62d03dbcc019cb72ef349ed8c601be24c1598efd0cb38e26397decb4e09a
+  metadata.gz: 311478a282f72c7b703594ec119dfc2686ec8cd3c6d6e97ff9fab9a32638e09eacefdc82a3808c581e48ab2af4cbfb26f66c7064cb614367cb4916fdf3b7df76
+  data.tar.gz: 3c059cb40bfa81c45a60bc9d107be8402923f92f0a8e1b50c6cdfcad88a4da6407244f1e5220d58f59a938c3d77e748ec22f360b8cf49041279616138ac4397d

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

@@ -1,7 +1,7 @@
 ---
 layout: default
 title: Changelog
-nav_order: 5
+nav_order: 6
 ---
 
 <!-- Add unreleased changes under the "main" heading. -->
@@ -10,6 +10,300 @@ nav_order: 5
 
 ## main
 
+## 3.23.2
+
+* Include .tt files in published gem. Fixes templates not being available when using generators.
+
+    *Florian Aßmann*
+
+## 3.23.1
+
+* Restore Rake tasks in published gem.
+
+    *Franz Liedke*
+
+## 3.23.0
+
+* Add docs about Slack channel in Ruby Central workspace. (Join us! #oss-view-component). Email joelhawksley@github.com for an invite.
+
+    *Joel Hawksley
+
+* Do not include internal `DocsBuilderComponent` or `YARD::MattrAccessorHandler` in published gem.
+
+    *Joel Hawksley*
+
+* Only lock to `concurrent-ruby` `1.3.4` for Rails 6.1.
+
+    *Joel Hawksley*
+
+* Fix generation of ViewComponent documentation that was broken due to HTML safety issues.
+
+    *Simon Fish*
+
+* Add documentation on how ViewComponent works.
+
+    *Joel Hawksley*
+
+* Clarify that `config.use_deprecated_instrumentation_name` will be removed in v4.
+
+    *Joel Hawksley*
+
+* Run RSpec tests in CI.
+
+    *Joel Hawksley*
+
+## 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.
+
+    *Nick Coyne*
+
+* Remove OpenStruct from codebase.
+
+    *Oleksii Vasyliev*
+
+## 3.19.0
+
+* Relax Active Support version constraint in gemspec.
+
+    *Simon Fish*
+
+## 3.18.0
+
+* Enable components to use `@request` and `request` methods/ivars.
+
+    *Blake Williams*
+
+* Fix bug where implicit locales in component filenames threw a `NameError`.
+
+    *Chloe Fons*
+
+* Register ViewComponent tests directory for `rails stats`.
+
+    *Javier Aranda*
+
+* Wrap entire compile step in a mutex to make it more resilient to race conditions.
+
+    *Blake Williams*
+
+* Add [Niva]([niva.co](https://www.niva.co/)) to companies who use `ViewComponent`.
+
+    *Daniel Vu Dao*
+
+* Fix `preview_paths` in docs.
+
+    *Javier Aranda*
+
+## 3.17.0
+
+* Use struct instead openstruct in lib code.
+
+    *Oleksii Vasyliev*
+
+* Fix bug where stimulus controller was not added to ERB when stimulus was activated by default.
+
+    *Denis Pasin*
+
+* Add typescript support to stimulus generator.
+
+    *Denis Pasin*
+
+* Fix the example of #vc_test_request in the API reference to use the correct method name.
+
+    *Alberto Rocha*
+
+* Fix development mode race condition that caused an invalid duplicate template error.
+
+    *Blake Williams*
+
+## 3.16.0
+
+* Add template information to multiple template error messages.
+
+    *Joel Hawksley*
+
+* Add `ostruct` to gemspec file to suppress stdlib removal warning.
+
+    *Jonathan Underwood*
+
+## 3.15.1
+
+* Re-add `@private`, undocumented `.identifier` method that was only meant for internal framework use but was used by some downstream consumers. This method will be removed in a coming minor release.
+
+    *Joel Hawksley*
+
+## 3.15.0
+
+* Add basic internal testing for memory allocations.
+
+    *Joel Hawksley*
+
+* Add support for request formats.
+
+    *Joel Hawksley*
+
+* Add `rendered_json` test helper.
+
+    *Joel Hawksley*
+
+* Add `with_format` test helper.
+
+    *Joel Hawksley*
+
+* Warn if using Ruby < 3.2 or Rails < 7.1, which won't be supported by ViewComponent v4, to be released no earlier than April 1, 2025.
+
+    *Joel Hawksley*
+
+* Add Kicksite to list of companies using ViewComponent.
+
+    *Adil Lari*
+
+* Allow overridden slot methods to use `super`.
+
+    *Andrew Schwartz*
+
+* Add Rails engine support to generators.
+
+    *Tomasz Kowalewski*
+
+* Register stats directories with `Rails::CodeStatistics.register_directory` to support `rails stats` in Rails 8.
+
+    *Petrik de Heus*
+
+* Fixed type declaration for `ViewComponent::TestHelpers.with_controller_class` parameter.
+
+    *Graham Rogers*
+
+## 3.14.0
+
+* Defer to built-in caching for language environment setup, rather than manually using `actions/cache` in CI.
+
+    *Simon Fish*
+
+* Add test coverage for use of `turbo_stream` helpers in components when `capture_compatibility_patch_enabled` is `true`.
+
+  *Simon Fish*
+
+* Add experimental `SlotableDefault` module, allowing components to define a `default_SLOTNAME` method to provide a default value for slots.
+
+    *Joel Hawksley*
+
+* Add documentation on rendering ViewComponents outside of the view context.
+
+    *Joel Hawksley*
+
+* Look for preview files that end in `preview.rb` rather than `_preview.rb` to allow previews to exist in sidecar directory with test files.
+
+    *Seth Herr*
+
+* Add `assert_component_rendered` test helper.
+
+    *Reegan Viljoen*
+
+* Add `prefix:` option to `use_helpers`.
+
+    *Reegan Viljoen*
+
+* Add support for Rails 7.2.
+
+    *Reegan Viljoen*
+
+## 3.13.0
+
+* Add ruby head and YJIT to CI.
+
+    *Reegan Viljoen*
+
+* Fixed a bug where inline templates where unable to remove trailing whitespace without throwing an error.
+
+    *Reegan Viljoen*
+
+* Fixed CI for Rails main.
+
+    *Reegan Viljoen*
+
+* Add `from:` option to `use_helpers` to allow for more flexible helper inclusion from modules.
+
+    *Reegan Viljoen*
+
+* Fixed ruby head matcher issue.
+
+    *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.
@@ -24,15 +318,15 @@ nav_order: 5
 
 * Fix templates not being correctly populated when caller location label has a prefix.
 
-On the upstream version of Ruby, method owners are now included in backtraces as prefixes. This caused the call stack filtering to not work as intended and thus `source_location` to be incorrect for child ViewComponents, consequently not populating templates correctly.
+  On the upstream version of Ruby, method owners are now included in backtraces as prefixes. This caused the call stack filtering to not work as intended and thus `source_location` to be incorrect for child ViewComponents, consequently not populating templates correctly.
 
     *Allan Pires, Jason Kim*
 
 * Use component path for generating RSpec files.
 
-When generating new RSpec files for components, the generator will use the `view_component_path` value in the config to decide where to put the new spec file. For instance, if the `view_component_path` option has been changed to `app/views/components`, the generator will put the spec file in `spec/views/components`. **If the `view_component_path` doesn't start with `app/`, then the generator will fall back to `spec/components/`.**
+  When generating new RSpec files for components, the generator will use the `view_component_path` value in the config to decide where to put the new spec file. For instance, if the `view_component_path` option has been changed to `app/views/components`, the generator will put the spec file in `spec/views/components`. **If the `view_component_path` doesn't start with `app/`, then the generator will fall back to `spec/components/`.**
 
-This feature is enabled via the `config.view_component.generate.use_component_path_for_rspec_tests` option, defaulting to `false`. The default will change to `true` in ViewComponent v4.
+  This feature is enabled via the `config.view_component.generate.use_component_path_for_rspec_tests` option, defaulting to `false`. The default will change to `true` in ViewComponent v4.
 
     *William Mathewson*
 
@@ -56,7 +350,7 @@ This feature is enabled via the `config.view_component.generate.use_component_pa
 
 * Include ViewComponent::UseHelpers by default.
 
-      *Reegan Viljoen*
+    *Reegan Viljoen*
 
 * Bump `puma` in Gemfile.lock.
 

data/lib/rails/generators/abstract_generator.rb

@@ -33,7 +33,7 @@ module ViewComponent
     end
 
     def stimulus_controller
-      if options["stimulus"]
+      if stimulus?
         File.join(destination_directory, destination_file_name)
           .sub("#{component_path}/", "")
           .tr("_", "-")
@@ -44,5 +44,13 @@ module ViewComponent
     def sidecar?
       options["sidecar"] || ViewComponent::Base.config.generate.sidecar
     end
+
+    def stimulus?
+      options["stimulus"] || ViewComponent::Base.config.generate.stimulus_controller
+    end
+
+    def typescript?
+      options["typescript"] || ViewComponent::Base.config.generate.typescript
+    end
   end
 end

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,6 +1,7 @@
 # frozen_string_literal: true
 
-class <%= class_name %>Component < <%= parent_class %>
+<% module_namespacing do -%>
+class <%= class_name %><%= options[:skip_suffix] ? "" : "Component" %> < <%= parent_class %>
 <%- if initialize_signature -%>
   def initialize(<%= initialize_signature %>)
     <%= initialize_body %>
@@ -11,5 +12,5 @@ class <%= class_name %>Component < <%= parent_class %>
     content_tag :h1, "Hello world!"<%= ", data: { controller: \"#{stimulus_controller}\" }" if options["stimulus"] %>
   end
 <%- end -%>
-
 end
+<% end -%>

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

@@ -24,7 +24,7 @@ module Erb
       private
 
       def data_attributes
-        if options["stimulus"]
+        if stimulus?
           " data-controller=\"#{stimulus_controller}\""
         end
       end

data/lib/rails/generators/preview/templates/component_preview.rb.tt

@@ -1,7 +1,9 @@
 # frozen_string_literal: true
 
+<% module_namespacing do -%>
 class <%= class_name %>ComponentPreview < ViewComponent::Preview
   def default
     render(<%= class_name %>Component.new<%= "(#{render_signature})" if render_signature %>)
   end
 end
+<% end -%>

data/lib/rails/generators/rspec/templates/component_spec.rb.tt

@@ -2,7 +2,7 @@
 
 require "rails_helper"
 
-RSpec.describe <%= class_name %>Component, type: :component do
+RSpec.describe <%= namespaced? ? "#{namespace.name}::" : '' %><%= class_name %>Component, type: :component do
   pending "add some examples to (or delete) #{__FILE__}"
 
   # it "renders something useful" do

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

@@ -9,9 +9,10 @@ module Stimulus
 
       source_root File.expand_path("templates", __dir__)
       class_option :sidecar, type: :boolean, default: false
+      class_option :typescript, type: :boolean, default: false
 
       def create_stimulus_controller
-        template "component_controller.js", destination
+        template "component_controller.#{filetype}", destination
       end
 
       def stimulus_module
@@ -22,11 +23,15 @@ module Stimulus
 
       private
 
+      def filetype
+        typescript? ? "ts" : "js"
+      end
+
       def destination
         if sidecar?
-          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component_controller.js")
+          File.join(component_path, class_path, "#{file_name}_component", "#{file_name}_component_controller.#{filetype}")
         else
-          File.join(component_path, class_path, "#{file_name}_component_controller.js")
+          File.join(component_path, class_path, "#{file_name}_component_controller.#{filetype}")
         end
       end
 

data/lib/rails/generators/stimulus/templates/component_controller.ts.tt

@@ -0,0 +1,9 @@
+import { Controller } from "<%= stimulus_module %>";
+
+export default class extends Controller {
+  declare element: HTMLElement;
+
+  connect() {
+    console.log("Hello, Stimulus!", this.element);
+  }
+}

data/lib/rails/generators/test_unit/templates/component_test.rb.tt

@@ -2,7 +2,7 @@
 
 require "test_helper"
 
-class <%= class_name %>ComponentTest < ViewComponent::TestCase
+class <%= namespaced? ? "#{namespace.name}::" : '' %><%= class_name %>ComponentTest < ViewComponent::TestCase
   def test_component_renders_something_useful
     # assert_equal(
     #   %(<span>Hello, components!</span>),