view_component 2.18.2 → 2.19.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a2198b33fb53185423a45c6f13023650604e7dacc2f5b44c2455f44b684ffdbc
-  data.tar.gz: f9eaffd030eb7bef12b243cfdf42333e4f5b28bf6a975f6b4720b65ef0d6aedc
+  metadata.gz: 365d7ffb66f4ec6321b0d736bf032d5fe2d9911e1aae9081f23fe09f53d2becc
+  data.tar.gz: c547db15e07b7e69d2422cacdf1d450ceeab79f6b9fdb2efcdd93867da68e5d8
 SHA512:
-  metadata.gz: 9ab6f420e32b85e912b4407ab3679e3fd696800547aecaa13c15c7833c82564f7ba8bc7db4fad8dbd7aa201250db156901486ee3c12b13f37ffedca3e5cbacf1
-  data.tar.gz: 22103cb47921ba57712808c6a3130f48926a40179a3564fab9b2235dc892edde3ed81df28e6c23535685d13121b4be1f232836612e7132d4be04143595eebb6d
+  metadata.gz: 5e73a2c8950e10c09f01231c8ba40906086f943cbcd670b79e807238047f4250ab9e214c8642ff464909913010a58cbc8dd8d7e006655092f565c34420690247
+  data.tar.gz: efb52c65561bf10cf345ddde5ecbfffec4543d568f32a8c4d61ea1152d8200c9fa0564152012414a48739054f568a4b20d5185431f7a84782152166e84a93a60

data/CHANGELOG.md

@@ -1,6 +1,22 @@
-# master
+# CHANGELOG
 
-# 2.18.2
+## master
+
+## 2.19.0
+
+* Extend documentation for using Stimulus within sidecar directories.
+
+    *Ciprian Redinciuc*
+
+* Subclassed components inherit templates from parent.
+
+    *Blake Williams*
+
+* Fix uninitialized constant error from `with_collection` when `eager_load` is disabled.
+
+    *Josh Gross*
+
+## 2.18.2
 
 * Raise an error if controller or view context is accessed during initialize as they are only available in render.
 
@@ -10,13 +26,13 @@
 
     *Joel Hawksley*
 
-# 2.18.1
+## 2.18.1
 
 * Fix bug where previews didn't work when monkey patch was disabled.
 
     *Mixer Gutierrez*
 
-# 2.18.0
+## 2.18.0
 
 * Fix auto-loading of previews (changes no longer require a server restart)
 
@@ -30,31 +46,31 @@
 
     *Brad Parker*
 
-# 2.17.1
+## 2.17.1
 
 * Fix bug where rendering Slot with empty block resulted in error.
 
     *Joel Hawksley*
 
-# 2.17.0
+## 2.17.0
 
 * Slots return stripped HTML, removing leading and trailing whitespace.
 
     *Jason Long, Joel Hawksley*
 
-# 2.16.0
+## 2.16.0
 
 * Add `--sidecar` option to the erb, haml and slim generators. Places the generated template in the sidecar directory.
 
     *Michael van Rooijen*
 
-# 2.15.0
+## 2.15.0
 
 * Add support for templates as ViewComponent::Preview examples.
 
     *Juan Manuel Ramallo
 
-# 2.14.1
+## 2.14.1
 
 * Allow using `render_inline` in test when the render monkey patch is disabled with `config.view_component.render_monkey_patch_enabled = false` in versions of Rails < 6.1.
 
@@ -64,14 +80,14 @@
 
     Fixes:
 
-    ```
+    ```console
     view_component/lib/view_component/slotable.rb:98: warning: Using the last argument as keyword parameters is deprecated; maybe ** should be added to the call
     view_component/test/app/components/slots_component.rb:18: warning: The called method `initialize' is defined here
     ```
 
     *Eileen M. Uchitelle*
 
-# 2.14.0
+## 2.14.0
 
 * Add `config.preview_paths` to support multiple locations of component preview files. Deprecate `config.preview_path`.
 
@@ -81,25 +97,25 @@
 
     *Richard Macklin*
 
-# 2.13.0
+## 2.13.0
 
 * Add the ability to disable the render monkey patch with `config.view_component.render_monkey_patch_enabled`. In versions of Rails < 6.1, add `render_component` and `render_component_to_string` methods which can be used for rendering components instead of `render`.
 
     *Johannes Engl*
 
-# 2.12.0
+## 2.12.0
 
 * Implement Slots as potential successor to Content Areas.
 
     *Jens Ljungblad, Brian Bugh, Jon Palmer, Joel Hawksley*
 
-# 2.11.1
+## 2.11.1
 
 * Fix kwarg warnings in Ruby 2.7.
 
     *Joel Hawksley*
 
-# 2.11.0
+## 2.11.0
 
 * Ensure Rails configuration is available within components.
 
@@ -109,25 +125,25 @@
 
     *Franco Sebregondi*
 
-# 2.10.0
+## 2.10.0
 
 * Raise an `ArgumentError` with a helpful message when Ruby cannot parse a component class.
 
     *Max Beizer*
 
-# 2.9.0
+## 2.9.0
 
 * Cache components per-request in development, preventing unnecessary recompilation during a single request.
 
     *Felipe Sateler*
 
-# 2.8.0
+## 2.8.0
 
 * Add `before_render`, deprecating `before_render_check`.
 
     *Joel Hawksley*
 
-# 2.7.0
+## 2.7.0
 
 * Add `rendered_component` method to `ViewComponent::TestHelpers` which exposes the raw output of the rendered component.
 
@@ -137,7 +153,7 @@
 
     *Jon Palmer*
 
-# 2.6.0
+## 2.6.0
 
 * Add `config.view_component.preview_route` to set the endpoint for component previews. By default `/rails/view_components` is used.
 
@@ -147,13 +163,13 @@
 
     *Joel Hawksley*
 
-# 2.5.1
+## 2.5.1
 
 * Compile component before rendering collection.
 
     *Rainer Borene*
 
-# v2.5.0
+## v2.5.0
 
 * Add counter variables when rendering collections.
 
@@ -163,7 +179,7 @@
 
     *Fabio Cantoni*
 
-# v2.4.0
+## v2.4.0
 
 * Add `#render_to_string` support.
 
@@ -181,7 +197,7 @@
 
     *Richard Macklin*
 
-# v2.3.0
+## v2.3.0
 
 * Allow using inline render method(s) defined on a parent.
 
@@ -195,19 +211,19 @@
 
     *Juan Manuel Ramallo*
 
-# v2.2.2
+## v2.2.2
 
 * Add `Base.format` for better compatibility with `ActionView::Template`.
 
     *Joel Hawksley*
 
-# v2.2.1
+## v2.2.1
 
 * Fix bug where template could not be found if `inherited` was redefined.
 
     *Joel Hawksley*
 
-# v2.2.0
+## v2.2.0
 
 * Add support for `config.action_view.annotate_template_file_names` (coming in Rails 6.1).
 
@@ -217,25 +233,25 @@
 
     *Vasiliy Ermolovich*
 
-# v2.1.0
+## v2.1.0
 
 * Support rendering collections (e.g., `render(MyComponent.with_collection(@items))`).
 
     *Tim Clem*
 
-# v2.0.0
+## v2.0.0
 
 * Move to `ViewComponent` namespace, removing all references to `ActionView`.
 
-    * The gem name is now `view_component`.
-    * ViewComponent previews are now accessed at `/rails/view_components`.
-    * ViewComponents can _only_ be rendered with the instance syntax: `render(MyComponent.new)`. Support for all other syntaxes has been removed.
-    * ActiveModel::Validations have been removed. ViewComponent generators no longer include validations.
-    * In Rails 6.1, no monkey patching is used.
-    * `to_component_class` has been removed.
-    * All gem configuration is now in `config.view_component`.
+  * The gem name is now `view_component`.
+  * ViewComponent previews are now accessed at `/rails/view_components`.
+  * ViewComponents can _only_ be rendered with the instance syntax: `render(MyComponent.new)`. Support for all other syntaxes has been removed.
+  * ActiveModel::Validations have been removed. ViewComponent generators no longer include validations.
+  * In Rails 6.1, no monkey patching is used.
+  * `to_component_class` has been removed.
+  * All gem configuration is now in `config.view_component`.
 
-# v1.17.0
+## v1.17.0
 
 * Support Ruby 2.4 in CI.
 
@@ -249,7 +265,7 @@
 
     *Joel Hawksley*
 
-# v1.16.0
+## v1.16.0
 
 * Add `refute_component_rendered` test helper.
 
@@ -263,7 +279,7 @@
 
     *Rainer Borene*
 
-# v1.15.0
+## v1.15.0
 
 * Re-introduce ActionView::Component::TestHelpers.
 
@@ -287,19 +303,19 @@
 
     *Sean Doyle*
 
-# v1.14.1
+## v1.14.1
 
 * Fix bug where generator created invalid test code.
 
     *Joel Hawksley*
 
-# v1.14.0
+## v1.14.0
 
 * Rename ActionView::Component::Base to ViewComponent::Base
 
     *Joel Hawksley*
 
-# v1.13.0
+## v1.13.0
 
 * Allow components to be rendered inside controllers.
 
@@ -309,7 +325,7 @@
 
     *Blake Williams*
 
-# v1.12.0
+## v1.12.0
 
 * Revert: Remove initializer requirement for Ruby 2.7+
 
@@ -323,13 +339,13 @@
 
     *Joel Hawksley*
 
-# v1.11.1
+## v1.11.1
 
 * Relax Capybara requirement.
 
     *Joel Hawksley*
 
-# v1.11.0
+## v1.11.0
 
 * Add support for Capybara matchers.
 
@@ -339,25 +355,25 @@
 
     *Asger Behncke Jacobsen*
 
-# v1.10.0
+## v1.10.0
 
 * Deprecate all `render` syntaxes except for `render(MyComponent.new(foo: :bar))`
 
     *Joel Hawksley*
 
-# v1.9.0
+## v1.9.0
 
 * Remove initializer requirement for Ruby 2.7+
 
     *Dylan Clark*
 
-# v1.8.1
+## v1.8.1
 
 * Run validation checks before calling `#render?`.
 
     *Ash Wilson*
 
-# v1.8.0
+## v1.8.0
 
 * Remove the unneeded ComponentExamplesController and simplify preview rendering.
 
@@ -383,7 +399,7 @@
 
     *Sergey Malykh*
 
-# v1.7.0
+## v1.7.0
 
 * Simplify validation of templates and compilation.
 
@@ -393,7 +409,7 @@
 
     *Jon Palmer*
 
-# v1.6.2
+## v1.6.2
 
 * Fix Uninitialized Constant error.
 
@@ -407,7 +423,7 @@
 
     *Justin Coyne*
 
-# v1.6.1
+## v1.6.1
 
 * Allow Previews to have no layout.
 
@@ -433,7 +449,7 @@
 
     *Ryan Workman*
 
-# v1.6.0
+## v1.6.0
 
 * Avoid dropping elements in the render_inline test helper.
 
@@ -463,7 +479,7 @@
 
     *Vinicius Stock*
 
-# v1.5.3
+## v1.5.3
 
 * Add support for RSpec to generators.
 
@@ -473,19 +489,19 @@
 
     *Joel Hawksley*
 
-# v1.5.2
+## v1.5.2
 
 * Disable eager loading initializer.
 
     *Kasper Meyer*
 
-# v1.5.1
+## v1.5.1
 
 * Update railties class to work with Rails 6.
 
     *Juan Manuel Ramallo*
 
-# v1.5.0
+## v1.5.0
 
 Note: `actionview-component` is now loaded by requiring `actionview/component`, not `actionview/component/base`.
 
@@ -505,7 +521,7 @@ Note: `actionview-component` is now loaded by requiring `actionview/component`,
 
     *Juan Manuel Ramallo*
 
-# v1.4.0
+## v1.4.0
 
 * Fix bug where components broke in application paths with periods.
 
@@ -527,7 +543,7 @@ Note: `actionview-component` is now loaded by requiring `actionview/component`,
 
     *Elia Schito*
 
-# v1.3.6
+## v1.3.6
 
 * Allow template file names without format.
 
@@ -537,7 +553,7 @@ Note: `actionview-component` is now loaded by requiring `actionview/component`,
 
     *Juan Manuel Ramallo*
 
-# v1.3.5
+## v1.3.5
 
 * Re-expose `controller` method.
 
@@ -551,7 +567,7 @@ Note: `actionview-component` is now loaded by requiring `actionview/component`,
 
     *ars moriendi*
 
-# v1.3.4
+## v1.3.4
 
 * Template errors surface correct file and line number.
 
@@ -561,57 +577,57 @@ Note: `actionview-component` is now loaded by requiring `actionview/component`,
 
     *Joel Hawksley*
 
-# v1.3.3
+## v1.3.3
 
-*   Do not raise error when sidecar files that are not templates exist.
+* Do not raise error when sidecar files that are not templates exist.
 
     *Joel Hawksley*
 
-# v1.3.2
+## v1.3.2
 
-*   Support rendering views from inside component templates.
+* Support rendering views from inside component templates.
 
     *Patrick Sinclair*
 
-# v1.3.1
+## v1.3.1
 
-*   Fix bug where rendering nested content caused an error.
+* Fix bug where rendering nested content caused an error.
 
     *Joel Hawksley, Aaron Patterson*
 
-# v1.3.0
+## v1.3.0
 
-*   Components are rendered with enough controller context to support rendering of partials and forms.
+* Components are rendered with enough controller context to support rendering of partials and forms.
 
     *Patrick Sinclair, Joel Hawksley, Aaron Patterson*
 
-# v1.2.1
+## v1.2.1
 
-*   `actionview-component` is now tested against Ruby 2.3/2.4 and Rails 5.0.0.
+* `actionview-component` is now tested against Ruby 2.3/2.4 and Rails 5.0.0.
 
-# v1.2.0
+## v1.2.0
 
-*   The `render_component` test helper has been renamed to `render_inline`. `render_component` has been deprecated and will be removed in v2.0.0.
+* The `render_component` test helper has been renamed to `render_inline`. `render_component` has been deprecated and will be removed in v2.0.0.
 
     *Joel Hawksley*
 
-*   Components are now rendered with `render MyComponent, foo: :bar` syntax. The existing `render MyComponent.new(foo: :bar)` syntax has been deprecated and will be removed in v2.0.0.
+* Components are now rendered with `render MyComponent, foo: :bar` syntax. The existing `render MyComponent.new(foo: :bar)` syntax has been deprecated and will be removed in v2.0.0.
 
     *Joel Hawksley*
 
-# v1.1.0
+## v1.1.0
 
-*   Components now inherit from ActionView::Component::Base
+* Components now inherit from ActionView::Component::Base
 
     *Joel Hawksley*
 
-# v1.0.1
+## v1.0.1
 
-*   Always recompile component templates outside production.
+* Always recompile component templates outside production.
 
     *Joel Hawksley, John Hawthorn*
 
-# v1.0.0
+## v1.0.0
 
 This release extracts the `ActionView::Component` library from the GitHub application.
 

data/README.md

@@ -1,10 +1,13 @@
 # ViewComponent
+
 ViewComponent is a framework for building view components that are reusable, testable & encapsulated, in Ruby on Rails.
 
 ## Design philosophy
+
 ViewComponent is designed to integrate as seamlessly as possible [with Rails](https://rubyonrails.org/doctrine/), with the [least surprise](https://www.artima.com/intv/ruby4.html).
 
 ## Compatibility
+
 ViewComponent is [supported natively](https://edgeguides.rubyonrails.org/layouts_and_rendering.html#rendering-objects) in Rails 6.1, and compatible with Rails 5.0+ via an included [monkey patch](https://github.com/github/view_component/blob/master/lib/view_component/render_monkey_patch.rb).
 
 ViewComponent is tested for compatibility [with combinations of](https://github.com/github/view_component/blob/22e3d4ccce70d8f32c7375e5a5ccc3f70b22a703/.github/workflows/ruby_on_rails.yml#L10-L11) Ruby 2.4+ and Rails 5+.
@@ -67,6 +70,8 @@ Component names end in -`Component`.
 
 Component module names are plural, as for controllers and jobs: `Users::AvatarComponent`
 
+Name components for what they render, not what they accept. (`AvatarComponent` instead of `UserComponent`)
+
 #### Quick start
 
 Use the component generator to create a new ViewComponent.
@@ -94,6 +99,7 @@ bin/rails generate component Example title content --template-engine slim
 A ViewComponent is a Ruby file and corresponding template file with the same base name:
 
 `app/components/test_component.rb`:
+
 ```ruby
 class TestComponent < ViewComponent::Base
   def initialize(title:)
@@ -103,6 +109,7 @@ end
 ```
 
 `app/components/test_component.html.erb`:
+
 ```erb
 <span title="<%= @title %>"><%= content %></span>
 ```
@@ -128,6 +135,7 @@ Content passed to a ViewComponent as a block is captured and assigned to the `co
 ViewComponents can declare additional content areas. For example:
 
 `app/components/modal_component.rb`:
+
 ```ruby
 class ModalComponent < ViewComponent::Base
   with_content_areas :header, :body
@@ -135,6 +143,7 @@ end
 ```
 
 `app/components/modal_component.html.erb`:
+
 ```erb
 <div class="modal">
   <div class="header"><%= header %></div>
@@ -174,7 +183,7 @@ By default, slots can be rendered once per component. They provide an accessor w
 
 Slots declared with `collection: true` can be rendered multiple times. They provide an accessor with the pluralized name of the slot (`#rows`), which is an Array of `ViewComponent::Slot` instances.
 
-To learn more about the design of the Slots API, see https://github.com/github/view_component/pull/348 and https://github.com/github/view_component/discussions/325.
+To learn more about the design of the Slots API, see [#348](https://github.com/github/view_component/pull/348) and [#325](https://github.com/github/view_component/discussions/325).
 
 ##### Defining Slots
 
@@ -195,6 +204,7 @@ _Note: Slot classes must be subclasses of `ViewComponent::Slot`._
 ##### Example ViewComponent with Slots
 
 `# box_component.rb`
+
 ```ruby
 class BoxComponent < ViewComponent::Base
   include ViewComponent::Slotable
@@ -239,6 +249,7 @@ end
 ```
 
 `# box_component.html.erb`
+
 ```erb
 <div class="Box">
   <% if header %>
@@ -269,6 +280,7 @@ end
 ```
 
 `# index.html.erb`
+
 ```erb
 <%= render(BoxComponent.new) do |component| %>
   <% component.slot(:header, classes: "my-class-name") do %>
@@ -294,6 +306,7 @@ end
 ViewComponents can render without a template file, by defining a `call` method:
 
 `app/components/inline_component.rb`:
+
 ```ruby
 class InlineComponent < ViewComponent::Base
   def call
@@ -320,6 +333,18 @@ class InlineVariantComponent < ViewComponent::Base
 end
 ```
 
+### Template Inheritance
+
+Components that subclass another component inherit the parent component's
+template if they don't define their own template.
+
+```ruby
+# If `my_link_component.html.erb` is not defined the component will fall back
+# to `LinkComponent`s template
+class MyLinkComponent < LinkComponent
+end
+```
+
 ### Sidecar Assets
 
 ViewComponents supports two options for defining view files.
@@ -328,7 +353,7 @@ ViewComponents supports two options for defining view files.
 
 The simplest option is to place the view next to the Ruby component:
 
-```
+```console
 app/components
 ├── ...
 ├── test_component.rb
@@ -340,7 +365,7 @@ app/components
 
 As an alternative, views and other assets can be placed in a sidecar directory with the same name as the component, which can be useful for organizing views alongside other assets like Javascript and CSS.
 
-```
+```console
 app/components
 ├── ...
 ├── example_component.rb
@@ -349,12 +374,11 @@ app/components
 |   ├── example_component.html.erb
 |   └── example_component.js
 ├── ...
-
 ```
 
 To generate a component with a sidecar directory, use the `--sidecar` flag:
 
-```
+```console
 bin/rails generate component Example title content --sidecar
       invoke  test_unit
       create  test/components/example_component_test.rb
@@ -368,7 +392,7 @@ It's also possible to place the Ruby component file inside the sidecar directory
 
 _Note: Avoid giving your containing folder the same name as your `.rb` file or there will be a conflict between Module and Class definitions_
 
-```
+```console
 app/components
 ├── ...
 ├── example
@@ -395,7 +419,8 @@ Components can implement a `#render?` method to be called after initialization t
 Traditionally, the logic for whether to render a view could go in either the component template:
 
 `app/components/confirm_email_component.html.erb`
-```
+
+```erb
 <% if user.requires_confirmation? %>
   <div class="alert">Please confirm your email address.</div>
 <% end %>
@@ -404,6 +429,7 @@ Traditionally, the logic for whether to render a view could go in either the com
 or the view that renders the component:
 
 `app/views/_banners.html.erb`
+
 ```erb
 <% if current_user.requires_confirmation? %>
   <%= render(ConfirmEmailComponent.new(user: current_user)) %>
@@ -413,6 +439,7 @@ or the view that renders the component:
 Using the `#render?` hook simplifies the view:
 
 `app/components/confirm_email_component.rb`
+
 ```ruby
 class ConfirmEmailComponent < ViewComponent::Base
   def initialize(user:)
@@ -426,13 +453,15 @@ end
 ```
 
 `app/components/confirm_email_component.html.erb`
-```
+
+```erb
 <div class="banner">
   Please confirm your email address.
 </div>
 ```
 
 `app/views/_banners.html.erb`
+
 ```erb
 <%= render(ConfirmEmailComponent.new(user: current_user)) %>
 ```
@@ -444,6 +473,7 @@ _To assert that a component has not been rendered, use `refute_component_rendere
 Components can define a `before_render` method to be called before a component is rendered, when `helpers` is able to be used:
 
 `app/components/confirm_email_component.rb`
+
 ```ruby
 class MyComponent < ViewComponent::Base
   def before_render
@@ -457,11 +487,13 @@ end
 Use `with_collection` to render a ViewComponent with a collection:
 
 `app/view/products/index.html.erb`
+
 ``` erb
 <%= render(ProductComponent.with_collection(@products)) %>
 ```
 
 `app/components/product_component.rb`
+
 ``` ruby
 class ProductComponent < ViewComponent::Base
   def initialize(product:)
@@ -477,6 +509,7 @@ end
 Use `with_collection_parameter` to change the name of the collection parameter:
 
 `app/components/product_component.rb`
+
 ``` ruby
 class ProductComponent < ViewComponent::Base
   with_collection_parameter :item
@@ -492,11 +525,13 @@ end
 Additional arguments besides the collection are passed to each component instance:
 
 `app/view/products/index.html.erb`
+
 ``` erb
 <%= render(ProductComponent.with_collection(@products, notice: "hi")) %>
 ```
 
 `app/components/product_component.rb`
+
 ``` ruby
 class ProductComponent < ViewComponent::Base
   with_collection_parameter :item
@@ -509,6 +544,7 @@ end
 ```
 
 `app/components/product_component.html.erb`
+
 ``` erb
 <li>
   <h2><%= @item.name %></h2>
@@ -521,6 +557,7 @@ end
 ViewComponent defines a counter variable matching the parameter name above, followed by `_counter`. To access the variable, add it to `initialize` as an argument:
 
 `app/components/product_component.rb`
+
 ``` ruby
 class ProductComponent < ViewComponent::Base
   def initialize(product:, product_counter:)
@@ -531,6 +568,7 @@ end
 ```
 
 `app/components/product_component.html.erb`
+
 ``` erb
 <li>
   <%= @counter %> <%= @product.name %>
@@ -579,7 +617,7 @@ class UserComponent < ViewComponent::Base
 end
 ```
 
-### Testing
+### Writing tests
 
 Unit test components directly, using the `render_inline` test helper, asserting against the rendered output.
 
@@ -647,9 +685,11 @@ end
 ```
 
 ### Previewing Components
+
 `ViewComponent::Preview`, like `ActionMailer::Preview`, provides a way to preview components in isolation:
 
 `test/components/previews/test_component_preview.rb`
+
 ```ruby
 class TestComponentPreview < ViewComponent::Preview
   def with_default_title
@@ -677,6 +717,7 @@ and <http://localhost:3000/rails/view_components/test_component/with_content_blo
 It's also possible to set dynamic values from the params by setting them as arguments:
 
 `test/components/previews/test_component_preview.rb`
+
 ```ruby
 class TestComponentPreview < ViewComponent::Preview
   def with_dynamic_title(title: "Test component default")
@@ -694,6 +735,7 @@ and [`content_tag`](https://api.rubyonrails.org/classes/ActionView/Helpers/TagHe
 Previews use the application layout by default, but can use a specific layout with the `layout` option:
 
 `test/components/previews/test_component_preview.rb`
+
 ```ruby
 class TestComponentPreview < ViewComponent::Preview
   layout "admin"
@@ -705,6 +747,7 @@ end
 You can also set a custom layout to be used by default for previews as well as the preview index pages via the `default_preview_layout` configuration option:
 
 `config/application.rb`
+
 ```ruby
 # Set the default layout to app/views/layouts/component_preview.html.erb
 config.view_component.default_preview_layout = "component_preview"
@@ -713,6 +756,7 @@ config.view_component.default_preview_layout = "component_preview"
 Preview classes live in `test/components/previews`, which can be configured using the `preview_paths` option:
 
 `config/application.rb`
+
 ```ruby
 config.view_component.preview_paths << "#{Rails.root}/lib/component_previews"
 ```
@@ -720,6 +764,7 @@ config.view_component.preview_paths << "#{Rails.root}/lib/component_previews"
 Previews are served from <http://localhost:3000/rails/view_components> by default. To use a different endpoint, set the `preview_route` option:
 
 `config/application.rb`
+
 ```ruby
 config.view_component.preview_route = "/previews"
 ```
@@ -731,6 +776,7 @@ This example will make the previews available from <http://localhost:3000/previe
 Given a preview `test/components/previews/cell_component_preview.rb`, template files can be defined at `test/components/previews/cell_component_preview/`:
 
 `test/components/previews/cell_component_preview.rb`
+
 ```ruby
 class CellComponentPreview < ViewComponent::Preview
   def default
@@ -739,6 +785,7 @@ end
 ```
 
 `test/components/previews/cell_component_preview/default.html.erb`
+
 ```erb
 <table class="table">
   <tbody>
@@ -753,6 +800,7 @@ To use a different location for preview templates, pass the `template` argument:
 (the path should be relative to `config.view_component.preview_path`):
 
 `test/components/previews/cell_component_preview.rb`
+
 ```ruby
 class CellComponentPreview < ViewComponent::Preview
   def default
@@ -764,6 +812,7 @@ end
 Values from `params` can be accessed through `locals`:
 
 `test/components/previews/cell_component_preview.rb`
+
 ```ruby
 class CellComponentPreview < ViewComponent::Preview
   def default(title: "Default title", subtitle: "A subtitle")
@@ -782,6 +831,7 @@ Which enables passing in a value with <http://localhost:3000/rails/components/ce
 Component tests and previews assume the existence of an `ApplicationController` class, which be can be configured using the `test_controller` option:
 
 `config/application.rb`
+
 ```ruby
 config.view_component.test_controller = "BaseController"
 ```
@@ -791,6 +841,7 @@ config.view_component.test_controller = "BaseController"
 To use RSpec, add the following:
 
 `spec/rails_helper.rb`
+
 ```ruby
 require "view_component/test_helpers"
 
@@ -804,6 +855,7 @@ Specs created by the generator have access to test helpers like `render_inline`.
 To use component previews:
 
 `config/application.rb`
+
 ```ruby
 config.view_component.preview_paths << "#{Rails.root}/spec/components/previews"
 ```
@@ -816,7 +868,7 @@ In order to [avoid conflicts](https://github.com/github/view_component/issues/28
 
 With the monkey patch disabled, use `render_component` (or  `render_component_to_string`) instead:
 
-```
+```erb
 <%= render_component Component.new(message: "bar") %>
 ```
 
@@ -854,6 +906,7 @@ One approach is to use Web Components, which contain all Javascript functionalit
 For example:
 
 `app/components/comment_component.rb`
+
 ```ruby
 class CommentComponent < ViewComponent::Base
   def initialize(comment:)
@@ -883,6 +936,7 @@ end
 ```
 
 `app/components/comment_component.html.erb`
+
 ```erb
 <my-comment comment-id="<%= comment.id %>">
   <time slot="posted" datetime="<%= comment.created_at.iso8601 %>"><%= comment.created_at.strftime("%b %-d") %></time>
@@ -896,6 +950,7 @@ end
 ```
 
 `app/components/comment_component.js`
+
 ```js
 class Comment extends HTMLElement {
   styles() {
@@ -949,6 +1004,29 @@ application.load(
 
 This enables the creation of files such as `app/components/widget_controller.js`, where the controller identifier matches the `data-controller` attribute in the component's HTML template.
 
+When placing a Stimulus controller inside a sidecar directory, be aware that when referencing the controller [each forward slash in a namespaced controller file’s path becomes two dashes in its identifier](
+https://stimulusjs.org/handbook/installing#controller-filenames-map-to-identifiers):
+
+```console
+app/components
+├── ...
+├── example
+|   ├── component.rb
+|   ├── component.css
+|   ├── component.html.erb
+|   └── component_controller.js
+├── ...
+```
+
+`component_controller.js`'s Stimulus identifier becomes: `example--component`:
+
+```erb
+<div data-controller="example--component">
+  <input type="text">
+  <button data-action="click->example--component#greet">Greet</button>
+</div>
+```
+
 ## Frequently Asked Questions
 
 ### Can I use other templating languages besides ERB?
@@ -980,7 +1058,7 @@ ViewComponent is far from a novel idea! Popular implementations of view componen
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/github/view_component. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. We recommend reading the [contributing guide](./CONTRIBUTING.md) as well.
+This project is intended to be a safe, welcoming space for collaboration. Contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct. We recommend reading the [contributing guide](./CONTRIBUTING.md) as well.
 
 ## Contributors
 

data/lib/view_component/base.rb

@@ -183,6 +183,10 @@ module ViewComponent
       end
 
       def inherited(child)
+        # Compile so child will inherit compiled `call_*` template methods that
+        # `compile` defines
+        compile
+
         # If we're in Rails, add application url_helpers to the component context
         if defined?(Rails)
           child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers

data/lib/view_component/collection.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require "action_view/renderer/collection_renderer" if Rails.version.to_f >= 6.1
+
 module ViewComponent
   class Collection
     def render_in(view_context, &block)

data/lib/view_component/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: view_component
 version: !ruby/object:Gem::Version
-  version: 2.18.2
+  version: 2.19.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-09-09 00:00:00.000000000 Z
+date: 2020-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport