actionview-component 1.9.0 → 1.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 67d62ba2c307963de0523a13f554d1e78b9e76990ace76c36b7d982ec83ef2cb
-  data.tar.gz: 66682a57cd5504b054c7c21227bbfb6cdc2c14f0ac151f2d6bb136a1f2e7a6cb
+  metadata.gz: 0521a37d11215c6cb0c08a78054dd57a4bdf53ebea65935908611f73264a1727
+  data.tar.gz: 470a3bdcfb35dcb37162ec708b22491d66f7d1772f40a483a160ed6b49477e3c
 SHA512:
-  metadata.gz: 0f5b33cb1dfff517ae58afb9167a5f0370f40902eef1ecfef1d6ee0e9f589a255826b92cbccf3bec5fd0a91d487601ec273f6238ddc029a3daade14aa5cd8a5a
-  data.tar.gz: f2f58364fba2269e40bf5bd1040872f826365f67e09679996c79999a0755a1ffdbe06f89bb661f80e7a23a2b4791dff6618b28da9a9cf062b1ca41f65ee69dfa
+  metadata.gz: d92b3636294971bb68eadbc7bf53799642d2407de53cd2d492fec6f1723e96668db1d030043e6c7a3fa0f04b484b72f70d5104dbb252ffbcf4efad02e82cdf78
+  data.tar.gz: 8b24889733157c2c8890362af41881047a81ae3bd0677d9fb6528ced72dd6505ee1fc12607ee120f978ce7933a7a4d2d000e0e4de3d7e76998df341646c2f1f8

data/.github/ISSUE_TEMPLATE

@@ -23,3 +23,5 @@ context or references to similar behavior in other libraries? -->
 **Rails version**:
 
 **Ruby version**:
+
+**Gem version**:

data/CHANGELOG.md

@@ -1,3 +1,51 @@
+# master
+
+# v1.13.0
+
+* Allow components to be rendered inside controllers.
+
+    *Joel Hawksley*
+
+* Improve backtraces from exceptions raised in templates.
+
+    *Blake Williams*
+
+# v1.12.0
+
+* Revert: Remove initializer requirement for Ruby 2.7+
+
+    *Joel Hawksley*
+
+* Restructure Railtie into Engine
+
+    *Sean Doyle*
+
+* Allow components to override before_render_check
+
+    *Joel Hawksley*
+
+# v1.11.1
+
+* Relax Capybara requirement.
+
+    *Joel Hawksley*
+
+# 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+

data/Gemfile.lock

@@ -1,7 +1,8 @@
 PATH
   remote: .
   specs:
-    actionview-component (1.9.0)
+    actionview-component (1.13.0)
+      capybara (>= 3)
 
 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)
@@ -96,11 +107,12 @@ GEM
     mini_portile2 (2.4.0)
     minitest (5.1.0)
     nio4r (2.5.2)
-    nokogiri (1.10.5)
+    nokogiri (1.10.8)
       mini_portile2 (~> 2.4.0)
     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)
@@ -131,7 +143,8 @@ GEM
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
     rainbow (3.0.0)
-    rake (10.5.0)
+    rake (13.0.1)
+    regexp_parser (1.7.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
@@ -178,7 +193,7 @@ DEPENDENCIES
   haml (~> 5)
   minitest (= 5.1.0)
   rails (= 6.0.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rubocop (= 0.74)
   rubocop-github (~> 0.13.0)
   slim (~> 4.0)

data/README.md

@@ -1,3 +1,7 @@
+_Note: This gem is in the process of a name / API change, see https://github.com/github/actionview-component/issues/206_
+
+_You are viewing the README for the development version of ActionView::Component. If you are using the current release version you can find the README at https://github.com/github/actionview-component/blob/v1.11.1/README.md_
+
 # ActionView::Component
 `ActionView::Component` is a framework for building view components in Rails.
 
@@ -5,17 +9,17 @@
 
 ## Roadmap
 
-This gem is meant to serve as a precursor to upstreaming the `ActionView::Component` class into Rails. It also serves to enable the usage of `ActionView::Component` in older versions of Rails.
+Support for third-party component frameworks was merged into Rails `6.1.0.alpha` in https://github.com/rails/rails/pull/36388 and https://github.com/rails/rails/pull/37919. Our goal with this project is to provide a first-class component framework for this new capability in Rails.
 
-Preliminary support for rendering components was merged into Rails `6.1.0.alpha` in https://github.com/rails/rails/pull/36388. Assuming `ActionView::Component` makes it into Rails, this gem will then exist to serve as a backport.
+This gem includes a backport of those changes for Rails `5.0.0` through `6.1.0.alpha`.
 
 ## Design philosophy
 
-As the goal of this gem is to be upstreamed into Rails, it is designed to integrate as seamlessly as possible, with the [least surprise](https://www.artima.com/intv/ruby4.html).
+This library is designed to integrate as seamlessly as possible with Rails, with the [least surprise](https://www.artima.com/intv/ruby4.html).
 
 ## Compatibility
 
-`actionview-component` is tested for compatibility with combinations of Ruby `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:
@@ -75,24 +79,14 @@ Our views often fail even the most basic standards of code quality we expect out
 
 By clearly defining the context necessary to render a component, we’ve found them to be easier to reuse than partials.
 
-#### Performance
-
-In early benchmarks, we’ve seen performance improvements over the existing rendering pipeline. For a test page with nested renders 10 levels deep, we’re seeing around a 5x increase in speed over partials:
-
-```
-Comparison:
-           component:     6515.4 i/s
-             partial:     1251.2 i/s - 5.21x  slower
-```
-
-_Rails 6.1.0.alpha, [joelhawksley/actionview-component-demo](https://github.com/joelhawksley/actionview-component-demo), /benchmark route, via `RAILS_ENV=production rails s`, measured with [evanphx/benchmark-ips](https://github.com/evanphx/benchmark-ips)_
-
 ### When should I use components?
 
 Components are most effective in cases where view code is reused or needs to be tested directly.
 
 ### Building components
 
+#### Conventions
+
 Components are subclasses of `ActionView::Component::Base` and live in `app/components`. You may wish to create an `ApplicationComponent` that is a subclass of `ActionView::Component::Base` and inherit from that instead.
 
 Component class names end in -`Component`.
@@ -117,6 +111,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 +150,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 +161,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 %>
 ```
@@ -213,6 +189,8 @@ class ModalComponent < ActionView::Component::Base
   def initialize(user:)
     @user = user
   end
+
+  attr_reader :user
 end
 ```
 
@@ -220,16 +198,16 @@ end
 ```erb
 <div class="modal">
   <div class="header"><%= header %></div>
-  <div class="body"><%= body %>"></div>
+  <div class="body"><%= body %></div>
 </div>
 ```
 
 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] %>
+      Hello <%= component.user[:name] %>
     <% end %>
   <% component.with(:body) do %>
     <p>Have a great day.</p>
@@ -265,8 +243,8 @@ end
 ```
 
 ```erb
-<%= render(ModalComponent, header: "Hi!") do |component| %>
-  <% help_enabled? && component.with(:header) do %>
+<%= render(ModalComponent.new(header: "Hi!")) do |component| %>
+  <% component.with(:header) do %>
     <span class="help_icon"><%= component.header %></span>
   <% end %>
   <% component.with(:body) do %>
@@ -292,7 +270,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 %>
@@ -332,13 +310,13 @@ end
   <% if header %>
     <div class="header"><%= header %></div>
   <% end %>
-  <div class="body"><%= body %>"></div>
+  <div class="body"><%= body %></div>
 </div>
 ```
 
 `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 %>
@@ -347,7 +325,7 @@ 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>
   <% end %>
@@ -359,7 +337,7 @@ 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 %>
@@ -386,7 +364,7 @@ or the view that renders the component:
 ```erb
 <!-- app/views/_banners.html.erb -->
 <% if current_user.requires_confirmation? %>
-  <%= render(ConfirmEmailComponent, user: current_user) %>
+  <%= render(ConfirmEmailComponent.new(user: current_user)) %>
 <% end %>
 ```
 
@@ -394,7 +372,7 @@ The `#render?` hook allows you to move this logic into the Ruby class, leaving y
 
 ```ruby
 # app/components/confirm_email_component.rb
-class ConfirmEmailComponent < ApplicationComponent
+class ConfirmEmailComponent < ActionView::Component::Base
   def initialize(user:)
     @user = user
   end
@@ -402,6 +380,8 @@ class ConfirmEmailComponent < ApplicationComponent
   def render?
     @user.requires_confirmation?
   end
+
+  attr_reader :user
 end
 ```
 
@@ -414,22 +394,21 @@ end
 
 ```erb
 <!-- app/views/_banners.html.erb -->
-<%= render(ConfirmEmailComponent, user: current_user) %>
+<%= 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
 ```
@@ -443,10 +422,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
 ```
@@ -462,11 +440,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
 ```
@@ -530,8 +508,7 @@ config.action_view_component.preview_path = "#{Rails.root}/spec/components/previ
 
 ### 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.
+ActionView::Component requires the presence of an `initialize` method in each component.
 
 ## Frequently Asked Questions
 
@@ -593,6 +570,11 @@ Bug reports and pull requests are welcome on GitHub at https://github.com/github
 |@mellowfish|@horacio|@dukex|@dark-panda|@smashwilson|
 |Spring Hill, TN|Buenos Aires|São Paulo||Gambrills, MD|
 
+|<img src="https://avatars.githubusercontent.com/blakewilliams?s=256" alt="blakewilliams" width="128" />|
+|:---:|
+|@blakewilliams|
+|Boston, MA|
+
 ## 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,8 +34,9 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = ">= 2.3.0"
 
+  spec.add_runtime_dependency     "capybara", ">= 3"
   spec.add_development_dependency "bundler", ">= 1.14"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13.0"
   spec.add_development_dependency "minitest", "= 5.1.0"
   spec.add_development_dependency "haml", "~> 5"
   spec.add_development_dependency "slim", "~> 4.0"

data/{lib/railties/lib → app/controllers}/rails/components_controller.rb

@@ -3,7 +3,7 @@
 require "rails/application_controller"
 
 class Rails::ComponentsController < Rails::ApplicationController # :nodoc:
-  prepend_view_path File.expand_path("templates/rails", __dir__)
+  prepend_view_path File.expand_path("../../../lib/railties/lib/rails/templates/rails", __dir__)
   prepend_view_path "#{Rails.root}/app/views/" if defined?(Rails.root)
 
   around_action :set_locale, only: :previews
@@ -17,19 +17,25 @@ class Rails::ComponentsController < Rails::ApplicationController # :nodoc:
   def index
     @previews = ActionView::Component::Preview.all
     @page_title = "Component Previews"
-    render template: "components/index"
+    # rubocop:disable GitHub/RailsControllerRenderPathsExist
+    render "components/index"
+    # rubocop:enable GitHub/RailsControllerRenderPathsExist
   end
 
   def previews
     if params[:path] == @preview.preview_name
       @page_title = "Component Previews for #{@preview.preview_name}"
-      render template: "components/previews"
+      # rubocop:disable GitHub/RailsControllerRenderPathsExist
+      render "components/previews"
+      # rubocop:enable GitHub/RailsControllerRenderPathsExist
     else
       @example_name = File.basename(params[:path])
       @render_args = @preview.render_args(@example_name)
       layout = @render_args[:layout]
       opts = layout.nil? ? {} : { layout: layout }
-      render template: "components/preview", **opts
+      # rubocop:disable GitHub/RailsControllerRenderPathsExist
+      render "components/preview", **opts
+      # rubocop:enable GitHub/RailsControllerRenderPathsExist
     end
   end
 

data/lib/action_view/component.rb

@@ -3,7 +3,7 @@
 require "active_model"
 require "action_view"
 require "active_support/dependencies/autoload"
-require "action_view/component/railtie"
+require "action_view/component/engine"
 
 module ActionView
   module Component
@@ -16,6 +16,7 @@ module ActionView
     autoload :TestHelpers
     autoload :TestCase
     autoload :RenderMonkeyPatch
+    autoload :RenderingMonkeyPatch
     autoload :TemplateError
   end
 end

data/lib/action_view/component/base.rb

@@ -14,10 +14,9 @@ module ActionView
       class_attribute :content_areas, default: []
       self.content_areas = [] # default doesn't work until Rails 5.2
 
-      # Entrypoint for rendering components. Called by ActionView::Base#render.
+      # Entrypoint for rendering components.
       #
       # view_context: ActionView context from calling view
-      # args(hash): params to be passed to component being rendered
       # block: optional block to be captured within the view context
       #
       # returns HTML that has been escaped by the respective template handler
@@ -35,11 +34,11 @@ module ActionView
       # <span title="<%= @title %>">Hello, <%= content %>!</span>
       #
       # In use:
-      # <%= render MyComponent, title: "greeting" do %>world<% end %>
+      # <%= render MyComponent.new(title: "greeting") do %>world<% end %>
       # returns:
       # <span title="greeting">Hello, world!</span>
       #
-      def render_in(view_context, *args, &block)
+      def render_in(view_context, &block)
         self.class.compile!
         @view_context = view_context
         @view_renderer ||= view_context.view_renderer
@@ -53,15 +52,21 @@ module ActionView
 
         @content = view_context.capture(self, &block) if block_given?
 
-        validate!
-
-        return "" unless render?
+        before_render_check
 
-        send(self.class.call_method_name(@variant))
+        if render?
+          send(self.class.call_method_name(@variant))
+        else
+          ""
+        end
       ensure
         @current_template = old_current_template
       end
 
+      def before_render_check
+        validate!
+      end
+
       def render?
         true
       end
@@ -142,14 +147,12 @@ module ActionView
 
         def source_location
           @source_location ||=
-              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
+            begin
+              # 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
         end
 
         def compiled?
@@ -172,7 +175,7 @@ module ActionView
           end
 
           templates.each do |template|
-            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+            class_eval <<-RUBY, template[:path], -1
               def #{call_method_name(template[:variant])}
                 @output_buffer = ActionView::OutputBuffer.new
                 #{compiled_template(template[:path])}
@@ -206,10 +209,6 @@ 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.chomp(File.extname(source_location))}.*{#{ActionView::Template.template_handler_extensions.join(',')}}"] - [source_location])
@@ -232,7 +231,7 @@ module ActionView
           @template_errors ||=
             begin
               errors = []
-              if source_location.nil? && !const_source_location_supported?
+              if source_location.nil?
                 # 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."

data/lib/action_view/component/engine.rb

@@ -0,0 +1,67 @@
+# frozen_string_literal: true
+
+require "rails"
+require "action_view/component"
+
+module ActionView
+  module Component
+    class Engine < Rails::Engine # :nodoc:
+      config.action_view_component = ActiveSupport::OrderedOptions.new
+
+      initializer "action_view_component.set_configs" do |app|
+        options = app.config.action_view_component
+
+        options.show_previews = Rails.env.development? if options.show_previews.nil?
+
+        if options.show_previews
+          options.preview_path ||= defined?(Rails.root) ? "#{Rails.root}/test/components/previews" : nil
+        end
+
+        ActiveSupport.on_load(:action_view_component) do
+          options.each { |k, v| send("#{k}=", v) }
+        end
+      end
+
+      initializer "action_view_component.set_autoload_paths" do |app|
+        options = app.config.action_view_component
+
+        if options.show_previews && options.preview_path
+          ActiveSupport::Dependencies.autoload_paths << options.preview_path
+        end
+      end
+
+      initializer "action_view_component.eager_load_actions" do
+        ActiveSupport.on_load(:after_initialize) do
+          ActionView::Component::Base.descendants.each(&:compile)
+        end
+      end
+
+      initializer "action_view_component.compile_config_methods" do
+        ActiveSupport.on_load(:action_view_component) do
+          config.compile_methods! if config.respond_to?(:compile_methods!)
+        end
+      end
+
+      initializer "action_view_component.monkey_patch_render" do
+        ActiveSupport.on_load(:action_view) do
+          ActionView::Base.prepend ActionView::Component::RenderMonkeyPatch
+        end
+
+        ActiveSupport.on_load(:action_controller) do
+          ActionController::Base.prepend ActionView::Component::RenderingMonkeyPatch
+        end
+      end
+
+      config.after_initialize do |app|
+        options = app.config.action_view_component
+
+        if options.show_previews
+          app.routes.prepend do
+            get "/rails/components"       => "rails/components#index", :internal => true
+            get "/rails/components/*path" => "rails/components#previews", :internal => true
+          end
+        end
+      end
+    end
+  end
+end

data/lib/action_view/component/railtie.rb

@@ -1,65 +1,3 @@
 # frozen_string_literal: true
 
-require "rails"
-require "action_view/component"
-
-module ActionView
-  module Component
-    class Railtie < Rails::Railtie # :nodoc:
-      config.action_view_component = ActiveSupport::OrderedOptions.new
-
-      initializer "action_view_component.set_configs" do |app|
-        options = app.config.action_view_component
-
-        options.show_previews = Rails.env.development? if options.show_previews.nil?
-
-        if options.show_previews
-          options.preview_path ||= defined?(Rails.root) ? "#{Rails.root}/test/components/previews" : nil
-        end
-
-        ActiveSupport.on_load(:action_view_component) do
-          options.each { |k, v| send("#{k}=", v) }
-        end
-      end
-
-      initializer "action_view_component.set_autoload_paths" do |app|
-        require "railties/lib/rails/components_controller"
-
-        options = app.config.action_view_component
-
-        if options.show_previews && options.preview_path
-          ActiveSupport::Dependencies.autoload_paths << options.preview_path
-        end
-      end
-
-      initializer "action_view_component.eager_load_actions" do
-        ActiveSupport.on_load(:after_initialize) do
-          ActionView::Component::Base.descendants.each(&:compile)
-        end
-      end
-
-      initializer "action_view_component.compile_config_methods" do
-        ActiveSupport.on_load(:action_view_component) do
-          config.compile_methods! if config.respond_to?(:compile_methods!)
-        end
-      end
-
-      initializer "action_view_component.monkey_patch_render" do
-        ActiveSupport.on_load(:action_view) do
-          ActionView::Base.prepend ActionView::Component::RenderMonkeyPatch
-        end
-      end
-
-      config.after_initialize do |app|
-        options = app.config.action_view_component
-
-        if options.show_previews
-          app.routes.prepend do
-            get "/rails/components"       => "rails/components#index", :internal => true
-            get "/rails/components/*path" => "rails/components#previews", :internal => true
-          end
-        end
-      end
-    end
-  end
-end
+require "action_view/component/engine"

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/rendering_monkey_patch.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module ActionView
+  module Component
+    module RenderingMonkeyPatch # :nodoc:
+      def render(options = {}, args = {})
+        if options.respond_to?(:render_in)
+          self.response_body = options.render_in(self.view_context)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/action_view/component/test_helpers.rb

@@ -1,10 +1,20 @@
 # 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

data/lib/action_view/component/version.rb

@@ -4,7 +4,7 @@ module ActionView
   module Component
     module VERSION
       MAJOR = 1
-      MINOR = 9
+      MINOR = 13
       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", class_path, "#{file_name}_component.rb")
       end
 
-      def create_template_file
-        template "component.html.erb", File.join("app/components", class_path, "#{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/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 -%>

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 1.9.0
+  version: 1.13.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-14 00:00:00.000000000 Z
+date: 2020-03-02 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -30,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -143,27 +157,34 @@ files:
 - README.md
 - Rakefile
 - actionview-component.gemspec
+- app/controllers/rails/components_controller.rb
 - lib/action_view/component.rb
 - lib/action_view/component/base.rb
 - lib/action_view/component/conversion.rb
+- lib/action_view/component/engine.rb
 - lib/action_view/component/preview.rb
 - lib/action_view/component/previewable.rb
 - lib/action_view/component/railtie.rb
 - lib/action_view/component/render_monkey_patch.rb
+- lib/action_view/component/rendering_monkey_patch.rb
 - lib/action_view/component/template_error.rb
 - lib/action_view/component/test_case.rb
 - lib/action_view/component/test_helpers.rb
 - 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/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