actionview-component 1.7.0 → 1.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: '085434585e1e3fa1493bbc7bd90439b1645015acd66a713a33545c0eb4677dc4'
-  data.tar.gz: 34ec8d8f390471689fbd1085c94885b74c4f9a1b0b7d9b78650dae506520dd13
+  metadata.gz: 2d2c0dab4ae3674f45f3f830257f49b108f51923e98a3de1182667f71a951cb2
+  data.tar.gz: 220a51f5dee367a6bf22e3a5306d17a2e302c5326cf4ad4a5f271c2ff0edb864
 SHA512:
-  metadata.gz: 89e3c7d8b6c1d67a29f2ad67a032e424c42f57dd719d5b8cbde01b167385d9d2aeb5feb8fd77fcd9284e0a33da828b935edeebbb758c7cd68951178eea2d3b14
-  data.tar.gz: bc76f28233c72f7d5ff3a818429e8c763649db3ec46e406b554070cd456b73ae923905ecb94d3b37949ca5c6b0960890594a341e72a9755343462cf4c5c24cff
+  metadata.gz: f9c79d7c62166ef2fb8f1cba5220d1599c8d6129252e09aec47917de3a7db1c3d9d6ef70da8231dc3389eac9e0136b2b533a972867a12ad975f8f5db9f49d5cc
+  data.tar.gz: efc71bebe0aeba60aeefdc00ae50d7485e2a28334c7b4764d359e84402e740f8aa0b66a36035be5223a2114c1e432c50c071d0924c2a3f90d8658f5e76a330d5

data/.github/ISSUE_TEMPLATE

@@ -6,17 +6,12 @@
 ### Motivation
 
 <!-- What would you like to do with this feature? Can you provide
-context or references to similar behavior in other libraries. -->
+context or references to similar behavior in other libraries? -->
 
-
-
-
-
-<!-- **** Filing a Bug Report? Include these sections. **** -->
+<!-- **** Filing a Bug Report? Include these sections: **** -->
 
 ### Steps to reproduce
-<!-- Provide an series of steps or, better yet, a link to a repo to
-demonstrate the bug you've identified. -->
+<!-- Provide a series of steps or, better yet, a link to a repo to demonstrate the bug you've identified. -->
 
 ### Expected behavior
 <!-- Tell us what should happen -->

data/.github/PULL_REQUEST_TEMPLATE

@@ -1,4 +1,4 @@
-<!-- https://github.com/github/actionview-component/blob/master/CONTRIBUTING.md#submitting-a-pull-request  -->
+<!-- See https://github.com/github/actionview-component/blob/master/CONTRIBUTING.md#submitting-a-pull-request  -->
 
 ### Summary
 
@@ -14,6 +14,4 @@ request, mention that information here. This could include
 benchmarks, or other information.
 
 If you are updating any of the CHANGELOG files or are asked to update the
-CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file.
-
-Thanks for contributing to actionview-component! -->
+CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file. -->

data/.github/workflows/ruby_on_rails.yml

@@ -8,7 +8,7 @@ jobs:
     strategy:
       matrix:
         rails_version: [5.0.0, 5.2.3, 6.0.0, master]
-        ruby_version: [2.4.x, 2.5.x, 2.6.x]
+        ruby_version: [2.5.x, 2.6.x, 2.7.x]
         exclude:
           - rails_version: master
             ruby_version: 2.4.x
@@ -22,7 +22,7 @@ jobs:
         ruby-version: ${{ matrix.ruby_version }}
     - name: Build and test with Rake
       run: |
-        gem install bundler:1.14.0
+        gem install bundler:1.17.3
         bundle update
         bundle install --jobs 4 --retry 3
         bundle exec rake

data/.gitignore

@@ -11,6 +11,7 @@
 /tmp/
 /test/log/*
 /test/app/tmp/*
+/test/tmp/*
 
 # Used by dotenv library to load environment variables.
 # .env

data/.rubocop.yml

@@ -2,3 +2,7 @@ inherit_gem:
   rubocop-github:
     - config/default.yml
     - config/rails.yml
+
+AllCops:
+  Exclude:
+    - "test/tmp/**/*"

data/CHANGELOG.md

@@ -1,3 +1,57 @@
+# v1.11.0
+
+* Add support for Capybara matchers.
+
+    *Joel Hawksley*
+
+* Add erb, haml, & slim template generators
+
+    *Asger Behncke Jacobsen*
+
+# v1.10.0
+
+* Deprecate all `render` syntaxes except for `render(MyComponent.new(foo: :bar))`
+
+    *Joel Hawksley*
+
+# v1.9.0
+
+* Remove initializer requirement for Ruby 2.7+
+
+    *Dylan Clark*
+
+# v1.8.1
+
+* Run validation checks before calling `#render?`.
+
+    *Ash Wilson*
+
+# v1.8.0
+
+* Remove the unneeded ComponentExamplesController and simplify preview rendering.
+
+    *Jon Palmer*
+
+* Add `#render?` hook to easily allow components to be no-ops.
+
+    *Kyle Fox*
+
+* Don't assume ApplicationController exists.
+
+    *Jon Palmer*
+
+* Allow some additional checks to overrided render?
+
+    *Sergey Malykh*
+
+* Fix generator placing namespaced components in the root directory.
+
+    *Asger Behncke Jacobsen*
+
+* Fix cache test.
+
+    *Sergey Malykh*
+
 # v1.7.0
 
 * Simplify validation of templates and compilation.

data/CONTRIBUTING.md

@@ -1,4 +1,4 @@
-## Contributing
+# Contributing
 
 [fork]: https://github.com/github/actionview-component/fork
 [pr]: https://github.com/github/actionview-component/compare
@@ -15,9 +15,11 @@ Please note that this project is released with a [Contributor Code of Conduct][c
 
 0. [Fork][fork] and clone the repository
 0. Configure and install the dependencies: `bundle`
-0. Make sure the tests pass on your machine: `rake`
+0. Make sure the tests pass on your machine: `bundle exec rake`
 0. Create a new branch: `git checkout -b my-branch-name`
 0. Make your change, add tests, and make sure the tests still pass
+0. Add an entry to the top of `CHANGELOG.md` for your changes
+0. If it's your first time contributing, add yourself to the contributors at the bottom of `README.md`
 0. Push to your fork and [submit a pull request][pr]
 0. Pat your self on the back and wait for your pull request to be reviewed and merged.
 
@@ -32,24 +34,13 @@ Here are a few things you can do that will increase the likelihood of your pull
 If you are the current maintainer of this gem:
 
 1. Create a branch for the release: `git checkout -b release-vxx.xx.xx`
-1. Bump gem version in `lib/action_view/component/version.rb`.
+1. Bump gem version in `lib/action_view/component/version.rb`. Try to adhere to SemVer.
 1. Add version heading/entries to `CHANGELOG.md`.
 1. Make sure your local dependencies are up to date: `bundle`
 1. Ensure that tests are green: `bundle exec rake`
-1. Build a test gem `GEM_VERSION=$(git describe --tags 2>/dev/null | sed 's/-/./g' | sed 's/v//') gem build actionview-component.gemspec`
-1. Test the test gem:
-   1. Bump the Gemfile and Gemfile.lock versions for an app which relies on this gem
-   1. Install the new gem locally
-   1. Test behavior locally, branch deploy, whatever needs to happen
 1. Make a PR to github/actionview-component.
 1. Build a local gem: `gem build actionview-component.gemspec`
 1. Merge github/actionview-component PR
 1. Tag and push: `git tag vx.xx.xx; git push --tags`
 1. Create a GitHub release with the pushed tag (https://github.com/github/actionview-component/releases/new) and populate it with a list of the commits from `git log --pretty=format:"- %s" --reverse refs/tags/[OLD TAG]...refs/tags/[NEW TAG]`
 1. Push to rubygems.org -- `gem push actionview-component-VERSION.gem`
-
-## Resources
-
-- [How to Contribute to Open Source](https://opensource.guide/how-to-contribute/)
-- [Using Pull Requests](https://help.github.com/articles/about-pull-requests/)
-- [GitHub Help](https://help.github.com)

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    actionview-component (1.7.0)
+    actionview-component (1.11.0)
+      capybara (>= 3.26)
 
 GEM
   remote: https://rubygems.org/
@@ -61,6 +62,8 @@ GEM
       minitest (~> 5.1)
       tzinfo (~> 1.1)
       zeitwerk (~> 2.1, >= 2.1.8)
+    addressable (2.7.0)
+      public_suffix (>= 2.0.2, < 5.0)
     ast (2.4.0)
     better_html (1.0.14)
       actionview (>= 4.0)
@@ -71,6 +74,14 @@ GEM
       parser (>= 2.4)
       smart_properties
     builder (3.2.3)
+    capybara (3.31.0)
+      addressable
+      mini_mime (>= 0.1.3)
+      nokogiri (~> 1.8)
+      rack (>= 1.6.0)
+      rack-test (>= 0.6.3)
+      regexp_parser (~> 1.5)
+      xpath (~> 3.2)
     concurrent-ruby (1.1.5)
     crass (1.0.5)
     erubi (1.8.0)
@@ -101,6 +112,7 @@ GEM
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
+    public_suffix (4.0.3)
     rack (2.0.8)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
@@ -132,6 +144,7 @@ GEM
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
     rake (10.5.0)
+    regexp_parser (1.6.0)
     rubocop (0.74.0)
       jaro_winkler (~> 1.5.1)
       parallel (~> 1.10)
@@ -166,6 +179,8 @@ GEM
     websocket-driver (0.7.1)
       websocket-extensions (>= 0.1.0)
     websocket-extensions (0.1.4)
+    xpath (3.2.0)
+      nokogiri (~> 1.8)
     zeitwerk (2.1.10)
 
 PLATFORMS

data/README.md

@@ -1,3 +1,5 @@
+_Note: This gem is in the process of a name / API change, see https://github.com/github/actionview-component/issues/206_
+
 # ActionView::Component
 `ActionView::Component` is a framework for building view components in Rails.
 
@@ -15,7 +17,7 @@ As the goal of this gem is to be upstreamed into Rails, it is designed to integr
 
 ## Compatibility
 
-`actionview-component` is tested for compatibility with combinations of Ruby `2.4`/`2.5`/`2.6` and Rails `5.0.0`/`5.2.3`/`6.0.0`/`6.1.0.alpha`.
+`actionview-component` is tested for compatibility with combinations of Ruby `2.5`/`2.6`/`2.7` and Rails `5.0.0`/`5.2.3`/`6.0.0`/`6.1.0.alpha`.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -117,6 +119,18 @@ bin/rails generate component Example title content
       create  app/components/example_component.html.erb
 ```
 
+`ActionView::Component` includes template generators for the `erb`, `haml`, and `slim` template engines and will use the template engine specified in your Rails config (`config.generators.template_engine`) by default.
+
+If you want to override this behavior, you can pass the template engine as an option to the generator:
+
+```bash
+bin/rails generate component Example title content --template-engine slim
+      invoke test_unit
+      create  test/components/example_component_test.rb
+      create  app/components/example_component.rb
+      create  app/components/example_component.html.slim
+```
+
 #### Implementation
 
 An `ActionView::Component` is a Ruby file and corresponding template file (in any format supported by Rails) with the same base name:
@@ -144,7 +158,7 @@ end
 We can render it in a view as:
 
 ```erb
-<%= render(TestComponent, title: "my title") do %>
+<%= render(TestComponent.new(title: "my title")) do %>
   Hello, World!
 <% end %>
 ```
@@ -155,42 +169,12 @@ Which returns:
 <span title="my title">Hello, World!</span>
 ```
 
-##### Supported `render` syntaxes
-
-Components can be rendered via:
-
-`render(TestComponent, foo: :bar)`
-
-`render(component: TestComponent, locals: { foo: :bar })`
-
-**Rendering components through models**
-
-Passing model instances will cause `render` to look for its respective component class.
-
-The component is instantiated with the rendered model instance.
-
-Example for a `Post` model:
-
-`render(@post)`
-
-```ruby
-class PostComponent < ActionView::Component::Base
-  def initialize(post)
-    @post = post
-  end
-end
-```
-
-The following syntax has been deprecated and will be removed in v2.0.0:
-
-`render(TestComponent.new(foo: :bar))`
-
 #### Error case
 
 If the component is rendered with a blank title:
 
 ```erb
-<%= render(TestComponent, title: "") do %>
+<%= render(TestComponent.new(title: "")) do %>
   Hello, World!
 <% end %>
 ```
@@ -201,7 +185,6 @@ An error will be raised:
 
 #### Content Areas
 
-
 A component can declare additional content areas to be rendered in the component. For example:
 
 `app/components/modal_component.rb`:
@@ -228,7 +211,7 @@ end
 We can render it in a view as:
 
 ```erb
-<%= render(ModalComponent, user: {name: 'Jane'}) do |component| %>
+<%= render(ModalComponent.new(user: {name: 'Jane'})) do |component| %>
   <% component.with(:header) do %>
       Hello <%= user[:name] %>
     <% end %>
@@ -266,7 +249,7 @@ end
 ```
 
 ```erb
-<%= render(ModalComponent, header: "Hi!") do |component| %>
+<%= render(ModalComponent.new(header: "Hi!")) do |component| %>
   <% help_enabled? && component.with(:header) do %>
     <span class="help_icon"><%= component.header %></span>
   <% end %>
@@ -293,7 +276,7 @@ end
 
 `app/views/render_arg.html.erb`:
 ```erb
-<%= render(ModalComponent, header: "Hi!") do |component| %>
+<%= render(ModalComponent.new(header: "Hi!")) do |component| %>
   <% component.with(:body) do %>
     <p>Have a great day.</p>
   <% end %>
@@ -304,7 +287,7 @@ end
 ```erb
 <%= render(ModalComponent) do |component| %>
   <% component.with(:header) do %>
-    <span class="help_icon">Hello</span> 
+    <span class="help_icon">Hello</span>
   <% end %>
   <% component.with(:body) do %>
     <p>Have a great day.</p>
@@ -339,7 +322,7 @@ end
 
 `app/views/render_arg.html.erb`:
 ```erb
-<%= render(ModalComponent, header: "Hi!") do |component| %>
+<%= render(ModalComponent.new(header: "Hi!")) do |component| %>
   <% component.with(:body) do %>
     <p>Have a great day.</p>
   <% end %>
@@ -348,9 +331,9 @@ end
 
 `app/views/with_block.html.erb`:
 ```erb
-<%= render(ModalComponent) do |component| %>
+<%= render(ModalComponent.new) do |component| %>
   <% component.with(:header) do %>
-    <span class="help_icon">Hello</span> 
+    <span class="help_icon">Hello</span>
   <% end %>
   <% component.with(:body) do %>
     <p>Have a great day.</p>
@@ -360,26 +343,76 @@ end
 
 `app/views/no_header.html.erb`:
 ```erb
-<%= render(ModalComponent) do |component| %>
+<%= render(ModalComponent.new) do |component| %>
   <% component.with(:body) do %>
     <p>Have a great day.</p>
   <% end %>
 <% end %>
 ```
 
+### Conditional Rendering
+
+Components can implement a `#render?` method which indicates if they should be rendered, or not at all.
+
+For example, you might have a component that displays a "Please confirm your email address" banner to users who haven't confirmed their email address. The logic for rendering the banner would need to go in either the component template:
+
+```
+<!-- app/components/confirm_email_component.html.erb -->
+<% if user.requires_confirmation? %>
+  <div class="alert">
+    Please confirm your email address.
+  </div>
+<% end %>
+```
+
+or the view that renders the component:
+
+```erb
+<!-- app/views/_banners.html.erb -->
+<% if current_user.requires_confirmation? %>
+  <%= render(ConfirmEmailComponent.new(user: current_user)) %>
+<% end %>
+```
+
+The `#render?` hook allows you to move this logic into the Ruby class, leaving your views more readable and declarative in style:
+
+```ruby
+# app/components/confirm_email_component.rb
+class ConfirmEmailComponent < ApplicationComponent
+  def initialize(user:)
+    @user = user
+  end
+
+  def render?
+    @user.requires_confirmation?
+  end
+end
+```
+
+```
+<!-- app/components/confirm_email_component.html.erb -->
+<div class="banner">
+  Please confirm your email address.
+</div>
+```
+
+```erb
+<!-- app/views/_banners.html.erb -->
+<%= render(ConfirmEmailComponent.new(user: current_user)) %>
+```
+
 ### Testing
 
-Components are unit tested directly. The `render_inline` test helper wraps the result in `Nokogiri.HTML`, allowing us to test the component above as:
+Components are unit tested directly. The `render_inline` test helper is compatible with Capybara matchers, allowing us to test the component above as:
 
 ```ruby
 require "action_view/component/test_case"
 
 class MyComponentTest < ActionView::Component::TestCase
   test "render component" do
-    assert_equal(
-      %(<span title="my title">Hello, World!</span>),
-      render_inline(TestComponent, title: "my title") { "Hello, World!" }.to_html
-    )
+    render_inline(TestComponent.new(title: "my title")) { "Hello, World!" }
+
+    assert_selector("span[title='my title']", "Hello, World!")
   end
 end
 ```
@@ -393,10 +426,9 @@ To test a specific variant you can wrap your test with the `with_variant` helper
 ```ruby
 test "render component for tablet" do
   with_variant :tablet do
-    assert_equal(
-      %(<span title="my title">Hello, tablets!</span>),
-      render_inline(TestComponent, title: "my title") { "Hello, tablets!" }.css("span").to_html
-    )
+    render_inline(TestComponent.new(title: "my title")) { "Hello, tablets!" }
+
+    assert_selector("span[title='my title']", "Hello, tablets!")
   end
 end
 ```
@@ -412,11 +444,11 @@ You can define as many examples as you want:
 
 class TestComponentPreview < ActionView::Component::Preview
   def with_default_title
-    render(TestComponent, title: "Test component default")
+    render(TestComponent.new(title: "Test component default"))
   end
 
   def with_long_title
-    render(TestComponent, title: "This is a really long title to see how the component renders this")
+    render(TestComponent.new(title: "This is a really long title to see how the component renders this"))
   end
 end
 ```
@@ -444,6 +476,16 @@ For example, if you want to use `lib/component_previews`, set the following in `
 config.action_view_component.preview_path = "#{Rails.root}/lib/component_previews"
 ```
 
+#### Configuring TestController
+
+By default components tests and previews expect your Rails project to contain an `ApplicationController` class from which Controller classes inherit.
+This can be configured using the `test_controller` option.
+For example, if your controllers inherit from `BaseController`, set the following in `config/application.rb`:
+
+```ruby
+config.action_view_component.test_controller = "BaseController"
+```
+
 ### Setting up RSpec
 
 If you're using RSpec, you can configure component specs to have access to test helpers. Add the following to
@@ -468,6 +510,11 @@ To use component previews, set the following in `config/application.rb`:
 config.action_view_component.preview_path = "#{Rails.root}/spec/components/previews"
 ```
 
+### Initializer requirement
+
+In Ruby 2.6.x and below, ActionView::Component requires the presence of an `initialize` method in each component. 
+However, `initialize` is no longer required for projects using 2.7.x and above.
+
 ## Frequently Asked Questions
 
 ### Can I use other templating languages besides ERB?
@@ -499,6 +546,35 @@ Inline templates have been removed (for now) due to concerns raised by [@soutaro
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/github/actionview-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.
 
+## Contributors
+
+`actionview-component` is built by:
+
+|<img src="https://avatars.githubusercontent.com/joelhawksley?s=256" alt="joelhawksley" width="128" />|<img src="https://avatars.githubusercontent.com/tenderlove?s=256" alt="tenderlove" width="128" />|<img src="https://avatars.githubusercontent.com/jonspalmer?s=256" alt="jonspalmer" width="128" />|<img src="https://avatars.githubusercontent.com/juanmanuelramallo?s=256" alt="juanmanuelramallo" width="128" />|<img src="https://avatars.githubusercontent.com/vinistock?s=256" alt="vinistock" width="128" />|
+|:---:|:---:|:---:|:---:|:---:|
+|@joelhawksley|@tenderlove|@jonspalmer|@juanmanuelramallo|@vinistock|
+|Denver|Seattle|Boston||Toronto|
+
+|<img src="https://avatars.githubusercontent.com/metade?s=256" alt="metade" width="128" />|<img src="https://avatars.githubusercontent.com/asgerb?s=256" alt="asgerb" width="128" />|<img src="https://avatars.githubusercontent.com/xronos-i-am?s=256" alt="xronos-i-am" width="128" />|<img src="https://avatars.githubusercontent.com/dylnclrk?s=256" alt="dylnclrk" width="128" />|<img src="https://avatars.githubusercontent.com/kaspermeyer?s=256" alt="kaspermeyer" width="128" />|
+|:---:|:---:|:---:|:---:|:---:|
+|@metade|@asgerb|@xronos-i-am|@dylnclrk|@kaspermeyer|
+|London|Copenhagen|Russia, Kirov|Berkeley, CA|Denmark|
+
+|<img src="https://avatars.githubusercontent.com/rdavid1099?s=256" alt="rdavid1099" width="128" />|<img src="https://avatars.githubusercontent.com/kylefox?s=256" alt="kylefox" width="128" />|<img src="https://avatars.githubusercontent.com/traels?s=256" alt="traels" width="128" />|<img src="https://avatars.githubusercontent.com/rainerborene?s=256" alt="rainerborene" width="128" />|<img src="https://avatars.githubusercontent.com/jcoyne?s=256" alt="jcoyne" width="128" />|
+|:---:|:---:|:---:|:---:|:---:|
+|@rdavid1099|@kylefox|@traels|@rainerborene|@jcoyne|
+|Los Angeles|Edmonton|Odense, Denmark|Brazil|Minneapolis|
+
+|<img src="https://avatars.githubusercontent.com/elia?s=256" alt="elia" width="128" />|<img src="https://avatars.githubusercontent.com/cesariouy?s=256" alt="cesariouy" width="128" />|<img src="https://avatars.githubusercontent.com/spdawson?s=256" alt="spdawson" width="128" />|<img src="https://avatars.githubusercontent.com/rmacklin?s=256" alt="rmacklin" width="128" />|<img src="https://avatars.githubusercontent.com/michaelem?s=256" alt="michaelem" width="128" />|
+|:---:|:---:|:---:|:---:|:---:|
+|@elia|@cesariouy|@spdawson|@rmacklin|@michaelem|
+|Milan||United Kingdom||Berlin|
+
+|<img src="https://avatars.githubusercontent.com/mellowfish?s=256" alt="mellowfish" width="128" />|<img src="https://avatars.githubusercontent.com/horacio?s=256" alt="horacio" width="128" />|<img src="https://avatars.githubusercontent.com/dukex?s=256" alt="dukex" width="128" />|<img src="https://avatars.githubusercontent.com/dark-panda?s=256" alt="dark-panda" width="128" />|<img src="https://avatars.githubusercontent.com/smashwilson?s=256" alt="smashwilson" width="128" />|
+|:---:|:---:|:---:|:---:|:---:|
+|@mellowfish|@horacio|@dukex|@dark-panda|@smashwilson|
+|Spring Hill, TN|Buenos Aires|São Paulo||Gambrills, MD|
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/actionview-component.gemspec

@@ -34,6 +34,7 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3.0"
 
+  spec.add_runtime_dependency     "capybara", ">= 3.26"
   spec.add_development_dependency "bundler", ">= 1.14"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "= 5.1.0"

data/lib/action_view/component/base.rb

@@ -47,6 +47,7 @@ module ActionView
         @view_flow ||= view_context.view_flow
         @virtual_path ||= virtual_path
         @variant = @lookup_context.variants.first
+
         old_current_template = @current_template
         @current_template = self
 
@@ -54,11 +55,17 @@ module ActionView
 
         validate!
 
+        return "" unless render?
+
         send(self.class.call_method_name(@variant))
       ensure
         @current_template = old_current_template
       end
 
+      def render?
+        true
+      end
+
       def initialize(*); end
 
       def render(options = {}, args = {}, &block)
@@ -112,6 +119,12 @@ module ActionView
 
       attr_reader :content, :view_context
 
+      # The controller used for testing components.
+      # Defaults to ApplicationController. This should be set early
+      # in the initialization process and should be set to a string.
+      mattr_accessor :test_controller
+      @@test_controller = "ApplicationController"
+
       class << self
         def inherited(child)
           child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
@@ -129,15 +142,11 @@ module ActionView
 
         def source_location
           @source_location ||=
-              begin
-                # Require #initialize to be defined so that we can use
-                # method#source_location to look up the file name
-                # of the component.
-                #
-                # If we were able to only support Ruby 2.7+,
-                # We could just use Module#const_source_location,
-                # rendering this unnecessary.
-                #
+              if const_source_location_supported?
+                const_source_location(self.name)[0]
+              else
+                # Require `#initialize` to be defined so that we can use `method#source_location`
+                # to look up the filename of the component.
                 initialize_method = instance_method(:initialize)
                 initialize_method.source_location[0] if initialize_method.owner == self
               end
@@ -197,9 +206,13 @@ module ActionView
 
         private
 
+        def const_source_location_supported?
+          respond_to? :const_source_location # introduced in Ruby 2.7
+        end
+
         def matching_views_in_source_location
           return [] unless source_location
-          (Dir["#{source_location.sub(/#{File.extname(source_location)}$/, '')}.*{#{ActionView::Template.template_handler_extensions.join(',')}}"] - [source_location])
+          (Dir["#{source_location.chomp(File.extname(source_location))}.*{#{ActionView::Template.template_handler_extensions.join(',')}}"] - [source_location])
         end
 
         def templates
@@ -219,7 +232,12 @@ module ActionView
           @template_errors ||=
             begin
               errors = []
-              errors << "#{self} must implement #initialize." if source_location.nil?
+              if source_location.nil? && !const_source_location_supported?
+                # Require `#initialize` to be defined so that we can use `method#source_location`
+                # to look up the filename of the component.
+                errors << "#{self} must implement #initialize."
+              end
+
               errors << "Could not find a template file for #{self}." if templates.empty?
 
               if templates.count { |template| template[:variant].nil? } > 1

data/lib/action_view/component/preview.rb

@@ -6,10 +6,9 @@ module ActionView
   module Component # :nodoc:
     class Preview
       extend ActiveSupport::DescendantsTracker
-      include ActionView::Component::TestHelpers
 
-      def render(component, *locals, &block)
-        render_inline(component, *locals, &block)
+      def render(component, **args, &block)
+        { component: component, args: args, block: block }
       end
 
       class << self
@@ -19,21 +18,14 @@ module ActionView
           descendants
         end
 
-        # Returns the html of the component in its layout
-        def call(example, layout: nil)
-          example_html = new.public_send(example)
-          if layout.nil?
-            layout = @layout.nil? ? "layouts/application" : @layout
-          end
-
-          Rails::ComponentExamplesController.render(template: "examples/show",
-                                                    layout: layout,
-                                                    assigns: { example: example_html })
+        # Returns the arguments for rendering of the component in its layout
+        def render_args(example)
+          new.public_send(example).merge(layout: @layout)
         end
 
         # Returns the component object class associated to the preview.
         def component
-          self.name.sub(%r{Preview$}, "").constantize
+          name.chomp("Preview").constantize
         end
 
         # Returns all of the available examples for the component preview.
@@ -58,7 +50,7 @@ module ActionView
 
         # Returns the underscored name of the component preview without the suffix.
         def preview_name
-          name.sub(/Preview$/, "").underscore
+          name.chomp("Preview").underscore
         end
 
         # Setter for layout name.

data/lib/action_view/component/railtie.rb

@@ -24,7 +24,6 @@ module ActionView
 
       initializer "action_view_component.set_autoload_paths" do |app|
         require "railties/lib/rails/components_controller"
-        require "railties/lib/rails/component_examples_controller"
 
         options = app.config.action_view_component
 

data/lib/action_view/component/render_monkey_patch.rb

@@ -1,24 +1,29 @@
 # frozen_string_literal: true
 
 # Monkey patch ActionView::Base#render to support ActionView::Component
-#
-# A version of this monkey patch was upstreamed in https://github.com/rails/rails/pull/36388
-# We'll need to upstream an updated version of this eventually.
 module ActionView
   module Component
     module RenderMonkeyPatch # :nodoc:
       def render(options = {}, args = {}, &block)
         if options.respond_to?(:render_in)
+          options.render_in(self, &block)
+        elsif options.is_a?(Class) && options < ActionView::Component::Base
           ActiveSupport::Deprecation.warn(
-            "passing component instances (`render MyComponent.new(foo: :bar)`) has been deprecated and will be removed in v2.0.0. Use `render MyComponent, foo: :bar` instead."
+            "`render MyComponent, foo: :bar` has been deprecated and will be removed in v2.0.0. Use `render MyComponent.new(foo: :bar)` instead."
           )
 
-          options.render_in(self, &block)
-        elsif options.is_a?(Class) && options < ActionView::Component::Base
           options.new(args).render_in(self, &block)
         elsif options.is_a?(Hash) && options.has_key?(:component)
+          ActiveSupport::Deprecation.warn(
+            "`render component: MyComponent, locals: { foo: :bar }` has been deprecated and will be removed in v2.0.0. Use `render MyComponent.new(foo: :bar)` instead."
+          )
+
           options[:component].new(options[:locals]).render_in(self, &block)
         elsif options.respond_to?(:to_component_class) && !options.to_component_class.nil?
+          ActiveSupport::Deprecation.warn(
+            "rendering objects that respond_to `to_component_class` has been deprecated and will be removed in v2.0.0. Use `render MyComponent.new(foo: :bar)` instead."
+          )
+
           options.to_component_class.new(options).render_in(self, &block)
         else
           super

data/lib/action_view/component/test_helpers.rb

@@ -1,14 +1,24 @@
 # frozen_string_literal: true
 
+require "capybara/minitest"
+
 module ActionView
   module Component
     module TestHelpers
+      include Capybara::Minitest::Assertions
+
+      def page
+        Capybara::Node::Simple.new(@raw)
+      end
+
       def render_inline(component, **args, &block)
-        Nokogiri::HTML.fragment(controller.view_context.render(component, args, &block))
+        @raw = controller.view_context.render(component, args, &block)
+
+        Nokogiri::HTML.fragment(@raw)
       end
 
       def controller
-        @controller ||= ApplicationController.new.tap { |c| c.request = request }
+        @controller ||= Base.test_controller.constantize.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
       end
 
       def request

data/lib/action_view/component/version.rb

@@ -4,7 +4,7 @@ module ActionView
   module Component
     module VERSION
       MAJOR = 1
-      MINOR = 7
+      MINOR = 11
       PATCH = 0
 
       STRING = [MAJOR, MINOR, PATCH].join(".")

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

@@ -6,15 +6,18 @@ module Rails
       source_root File.expand_path("templates", __dir__)
 
       argument :attributes, type: :array, default: [], banner: "attribute"
-      hook_for :test_framework
       check_class_collision suffix: "Component"
 
+      class_option :require_content, type: :boolean, default: false
+
       def create_component_file
-        template "component.rb", File.join("app/components",  "#{file_name}_component.rb")
+        template "component.rb", File.join("app/components", class_path, "#{file_name}_component.rb")
       end
 
-      def create_template_file
-        template "component.html.erb", File.join("app/components",  "#{file_name}_component.html.erb")
+      hook_for :test_framework
+
+      hook_for :template_engine do |instance, template_engine|
+        instance.invoke template_engine, [instance.name], require_content: instance.send(:requires_content?)
       end
 
       private
@@ -24,6 +27,7 @@ module Rails
       end
 
       def requires_content?
+        return if behavior == :revoke
         return @requires_content if @asked
 
         @asked = true

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rails/generators/erb"
+
+module Erb
+  module Generators
+    class ComponentGenerator < Base
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :require_content, type: :boolean, default: false
+
+      def copy_view_file
+        template "component.html.erb", File.join("app/components", class_path, "#{file_name}_component.html.erb")
+      end
+
+      private
+
+      def requires_content?
+        options["require_content"]
+      end
+
+      def file_name
+        @_file_name ||= super.sub(/_component\z/i, "")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rails/generators/erb/component_generator"
+
+module Haml
+  module Generators
+    class ComponentGenerator < Erb::Generators::ComponentGenerator
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :require_content, type: :boolean, default: false
+
+      def copy_view_file
+        template "component.html.haml", File.join("app/components", class_path, "#{file_name}_component.html.haml")
+      end
+
+      private
+
+      def requires_content?
+        options["require_content"]
+      end
+
+      def file_name
+        @_file_name ||= super.sub(/_component\z/i, "")
+      end
+    end
+  end
+end

data/lib/rails/generators/haml/templates/component.html.haml.tt

@@ -0,0 +1,5 @@
+<%- if requires_content? -%>
+<%= "= content" %>
+<%- else -%>
+%div Add <%= class_name %> template here
+<%- end -%>

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

@@ -6,7 +6,7 @@ module Rspec
       source_root File.expand_path("templates", __dir__)
 
       def create_test_file
-        template "component_spec.rb", File.join("spec/components", "#{file_name}_component_spec.rb")
+        template "component_spec.rb", File.join("spec/components", class_path, "#{file_name}_component_spec.rb")
       end
 
       private

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "rails/generators/erb/component_generator"
+
+module Slim
+  module Generators
+    class ComponentGenerator < Erb::Generators::ComponentGenerator
+      source_root File.expand_path("templates", __dir__)
+
+      class_option :require_content, type: :boolean, default: false
+
+      def copy_view_file
+        template "component.html.slim", File.join("app/components", class_path, "#{file_name}_component.html.slim")
+      end
+
+      private
+
+      def requires_content?
+        options["require_content"]
+      end
+
+      def file_name
+        @_file_name ||= super.sub(/_component\z/i, "")
+      end
+    end
+  end
+end

data/lib/rails/generators/slim/templates/component.html.slim

@@ -0,0 +1,5 @@
+<%- if requires_content? -%>
+= content
+<%- else -%>
+div Add <%= class_name %> template here
+<%- end -%>

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

@@ -7,7 +7,7 @@ module TestUnit
       check_class_collision suffix: "ComponentTest"
 
       def create_test_file
-        template "component_test.rb", File.join("test/components", "#{file_name}_component_test.rb")
+        template "component_test.rb", File.join("test/components", class_path, "#{file_name}_component_test.rb")
       end
 
       private

data/lib/railties/lib/rails.rb

@@ -2,5 +2,4 @@
 
 module Rails
   autoload :ComponentsController
-  autoload :ComponentExamplesController
 end

data/lib/railties/lib/rails/components_controller.rb

@@ -4,6 +4,7 @@ require "rails/application_controller"
 
 class Rails::ComponentsController < Rails::ApplicationController # :nodoc:
   prepend_view_path File.expand_path("templates/rails", __dir__)
+  prepend_view_path "#{Rails.root}/app/views/" if defined?(Rails.root)
 
   around_action :set_locale, only: :previews
   before_action :find_preview, only: :previews
@@ -25,7 +26,10 @@ class Rails::ComponentsController < Rails::ApplicationController # :nodoc:
       render template: "components/previews"
     else
       @example_name = File.basename(params[:path])
-      render template: "components/preview", layout: false
+      @render_args = @preview.render_args(@example_name)
+      layout = @render_args[:layout]
+      opts = layout.nil? ? {} : { layout: layout }
+      render template: "components/preview", **opts
     end
   end
 

data/lib/railties/lib/rails/templates/rails/components/preview.html.erb

@@ -1 +1 @@
-<%= raw @preview.call(@example_name) %>
+<%= render(@render_args[:component], **@render_args[:args], &@render_args[:block])%>

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 1.7.0
+  version: 1.11.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-09 00:00:00.000000000 Z
+date: 2020-02-19 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.26'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.26'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -156,19 +170,22 @@ files:
 - lib/action_view/component/version.rb
 - lib/rails/generators/component/USAGE
 - lib/rails/generators/component/component_generator.rb
-- lib/rails/generators/component/templates/component.html.erb.tt
 - lib/rails/generators/component/templates/component.rb.tt
+- lib/rails/generators/erb/component_generator.rb
+- 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/rspec/component_generator.rb
 - lib/rails/generators/rspec/templates/component_spec.rb.tt
+- lib/rails/generators/slim/component_generator.rb
+- lib/rails/generators/slim/templates/component.html.slim
 - lib/rails/generators/test_unit/component_generator.rb
 - lib/rails/generators/test_unit/templates/component_test.rb.tt
 - lib/railties/lib/rails.rb
-- lib/railties/lib/rails/component_examples_controller.rb
 - lib/railties/lib/rails/components_controller.rb
 - lib/railties/lib/rails/templates/rails/components/index.html.erb
 - lib/railties/lib/rails/templates/rails/components/preview.html.erb
 - lib/railties/lib/rails/templates/rails/components/previews.html.erb
-- lib/railties/lib/rails/templates/rails/examples/show.html.erb
 - script/bootstrap
 - script/console
 - script/install

data/lib/railties/lib/rails/component_examples_controller.rb

@@ -1,9 +0,0 @@
-# frozen_string_literal: true
-
-require "rails/application_controller"
-load "config/application.rb" unless Rails.root
-
-class Rails::ComponentExamplesController < ActionController::Base # :nodoc:
-  prepend_view_path File.expand_path("templates/rails", __dir__)
-  append_view_path Rails.root.join("app/views")
-end

data/lib/railties/lib/rails/templates/rails/examples/show.html.erb

@@ -1 +0,0 @@
-<%= raw @example %>