actionview-component 1.5.2 → 1.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 30c2d62abc3a38ba7f383a934ea3a95d6e490f81868d062d9263130e6d694d84
-  data.tar.gz: 8cc4375853920bd79183e9e634e00a9f4804726c2fc2a60328f3f1ad664bccef
+  metadata.gz: '085434585e1e3fa1493bbc7bd90439b1645015acd66a713a33545c0eb4677dc4'
+  data.tar.gz: 34ec8d8f390471689fbd1085c94885b74c4f9a1b0b7d9b78650dae506520dd13
 SHA512:
-  metadata.gz: 98e2021c3308374c1ef1d92d044b18bdcbb071e422a52cbfe102f984cbf34521d6c19b4f9b60b511f3f9ffa1e3b2e0fc7b5ec31dcf22420f5d4240baad42e881
-  data.tar.gz: 7e68770c3ec42381c7fce1028834b95ce4c6d04e1ce71e2849ce04a99b73b3539c2246c35bd77421a63c754e66fac083adaac1ae531bc37fb306293cd7a9a61e
+  metadata.gz: 89e3c7d8b6c1d67a29f2ad67a032e424c42f57dd719d5b8cbde01b167385d9d2aeb5feb8fd77fcd9284e0a33da828b935edeebbb758c7cd68951178eea2d3b14
+  data.tar.gz: bc76f28233c72f7d5ff3a818429e8c763649db3ec46e406b554070cd456b73ae923905ecb94d3b37949ca5c6b0960890594a341e72a9755343462cf4c5c24cff

data/.github/ISSUE_TEMPLATE

@@ -0,0 +1,30 @@
+<!-- **** Filing a Feature Request? Include these sections. **** -->
+
+### Feature request
+<!-- Provide a summary of the behavior. -->
+
+### Motivation
+
+<!-- What would you like to do with this feature? Can you provide
+context or references to similar behavior in other libraries. -->
+
+
+
+
+
+<!-- **** 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. -->
+
+### Expected behavior
+<!-- Tell us what should happen -->
+
+### Actual behavior
+<!-- Tell us what happens instead -->
+
+### System configuration
+**Rails version**:
+
+**Ruby version**:

data/.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,19 @@
+<!-- https://github.com/github/actionview-component/blob/master/CONTRIBUTING.md#submitting-a-pull-request  -->
+
+### Summary
+
+<!-- Provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together. -->
+
+### Other Information
+
+<!-- If there's anything else that's important and relevant to your pull
+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! -->

data/.gitignore

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

data/CHANGELOG.md

@@ -1,3 +1,93 @@
+# v1.7.0
+
+* Simplify validation of templates and compilation.
+
+    *Jon Palmer*
+
+* Add support for multiple content areas.
+
+    *Jon Palmer*
+
+# v1.6.2
+
+* Fix Uninitialized Constant error.
+
+    *Jon Palmer*
+
+* Add basic github issue and PR templates.
+
+    *Dylan Clark*
+
+* Update readme phrasing around previews.
+
+    *Justin Coyne*
+
+# v1.6.1
+
+* Allow Previews to have no layout.
+
+    *Jon Palmer*
+
+* Bump rack from 2.0.7 to 2.0.8.
+
+    *Dependabot*
+
+* Compile components on application boot when eager loading is enabled.
+
+    *Joel Hawksley*
+
+* Previews support content blocks.
+
+    *Cesario Uy*
+
+* Follow Rails conventions. (refactor)
+
+    *Rainer Borene*
+
+* Fix edge case issue with extracting variants from less conventional source_locations.
+
+    *Ryan Workman*
+
+# v1.6.0
+
+* Avoid dropping elements in the render_inline test helper.
+
+    *@dark-panda*
+
+* Add test for helpers.asset_url.
+
+    *Christopher Coleman*
+
+* Add rudimentary compatibility with better_html.
+
+    *Joel Hawksley*
+
+* Template-less variants fall back to default template.
+
+    *Asger Behncke Jacobsen*, *Cesario Uy*
+
+* Generated tests use new naming convention.
+
+    *Simon Træls Ravn*
+
+* Eliminate sqlite dependency.
+
+    *Simon Dawson*
+
+* Add support for rendering components via #to_component_class
+
+    *Vinicius Stock*
+
+# v1.5.3
+
+* Add support for RSpec to generators.
+
+    *Dylan Clark, Ryan Workman*
+
+* Require controllers as part of setting autoload paths.
+
+    *Joel Hawksley*
+
 # v1.5.2
 
 * Disable eager loading initializer.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actionview-component (1.5.2)
+    actionview-component (1.7.0)
 
 GEM
   remote: https://rubygems.org/
@@ -62,6 +62,14 @@ GEM
       tzinfo (~> 1.1)
       zeitwerk (~> 2.1, >= 2.1.8)
     ast (2.4.0)
+    better_html (1.0.14)
+      actionview (>= 4.0)
+      activesupport (>= 4.0)
+      ast (~> 2.0)
+      erubi (~> 1.4)
+      html_tokenizer (~> 0.0.6)
+      parser (>= 2.4)
+      smart_properties
     builder (3.2.3)
     concurrent-ruby (1.1.5)
     crass (1.0.5)
@@ -71,6 +79,7 @@ GEM
     haml (5.1.2)
       temple (>= 0.8.0)
       tilt
+    html_tokenizer (0.0.7)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.3)
@@ -92,7 +101,7 @@ GEM
     parallel (1.17.0)
     parser (2.6.3.0)
       ast (~> 2.4.0)
-    rack (2.0.7)
+    rack (2.0.8)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails (6.0.0)
@@ -139,6 +148,7 @@ GEM
     slim (4.0.1)
       temple (>= 0.7.6, < 0.9)
       tilt (>= 2.0.6, < 2.1)
+    smart_properties (1.15.0)
     sprockets (3.7.2)
       concurrent-ruby (~> 1.0)
       rack (> 1, < 3)
@@ -163,6 +173,7 @@ PLATFORMS
 
 DEPENDENCIES
   actionview-component!
+  better_html (~> 1)
   bundler (>= 1.14)
   haml (~> 5)
   minitest (= 5.1.0)

data/README.md

@@ -7,7 +7,7 @@
 
 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.
 
-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 `6.1`, this gem will then exist to serve as a backport.
+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.
 
 ## Design philosophy
 
@@ -32,7 +32,7 @@ $ bundle
 In `config/application.rb`, add:
 
 ```bash
-require "action_view/component"
+require "action_view/component/railtie"
 ```
 
 ## Guide
@@ -163,6 +163,24 @@ Components can be rendered via:
 
 `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))`
@@ -181,17 +199,183 @@ An error will be raised:
 
 `ActiveModel::ValidationError: Validation failed: Title can't be blank`
 
+#### Content Areas
+
+
+A component can declare additional content areas to be rendered in the component. For example:
+
+`app/components/modal_component.rb`:
+```ruby
+class ModalComponent < ActionView::Component::Base
+  validates :user, :header, :body, presence: true
+
+  with_content_areas :header, :body
+
+  def initialize(user:)
+    @user = user
+  end
+end
+```
+
+`app/components/modal_component.html.erb`:
+```erb
+<div class="modal">
+  <div class="header"><%= header %></div>
+  <div class="body"><%= body %>"></div>
+</div>
+```
+
+We can render it in a view as:
+
+```erb
+<%= render(ModalComponent, user: {name: 'Jane'}) do |component| %>
+  <% component.with(:header) do %>
+      Hello <%= user[:name] %>
+    <% end %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% end %>
+<% end %>
+```
+
+Which returns:
+
+```html
+<div class="modal">
+  <div class="header">Hello Jane</div>
+  <div class="body"><p>Have a great day.</p></div>
+</div>
+```
+
+Content for content areas can be passed as arguments to the render method or as named blocks passed to the `with` method.
+This allows a few different combinations of ways to render the component:
+
+##### Required render argument optionally overridden or wrapped by a named block
+
+`app/components/modal_component.rb`:
+```ruby
+class ModalComponent < ActionView::Component::Base
+  validates :header, :body, presence: true
+
+  with_content_areas :header, :body
+
+  def initialize(header:)
+    @header = header
+  end
+end
+```
+
+```erb
+<%= render(ModalComponent, header: "Hi!") do |component| %>
+  <% help_enabled? && component.with(:header) do %>
+    <span class="help_icon"><%= component.header %></span>
+  <% end %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% end %>
+<% end %>
+```
+
+##### Required argument passed by render argument or by named block
+
+`app/components/modal_component.rb`:
+```ruby
+class ModalComponent < ActionView::Component::Base
+  validates :header, :body, presence: true
+
+  with_content_areas :header, :body
+
+  def initialize(header: nil)
+    @header = header
+  end
+end
+```
+
+`app/views/render_arg.html.erb`:
+```erb
+<%= render(ModalComponent, header: "Hi!") do |component| %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% end %>
+<% end %>
+```
+
+`app/views/with_block.html.erb`:
+```erb
+<%= render(ModalComponent) do |component| %>
+  <% component.with(:header) do %>
+    <span class="help_icon">Hello</span> 
+  <% end %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% end %>
+<% end %>
+```
+
+##### Optional argument passed by render argument, by named block, or neither
+
+`app/components/modal_component.rb`:
+```ruby
+class ModalComponent < ActionView::Component::Base
+  validates :body, presence: true
+
+  with_content_areas :header, :body
+
+  def initialize(header: nil)
+    @header = header
+  end
+end
+```
+
+`app/components/modal_component.html.erb`:
+```erb
+<div class="modal">
+  <% if header %>
+    <div class="header"><%= header %></div>
+  <% end %>
+  <div class="body"><%= body %>"></div>
+</div>
+```
+
+`app/views/render_arg.html.erb`:
+```erb
+<%= render(ModalComponent, header: "Hi!") do |component| %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% end %>
+<% end %>
+```
+
+`app/views/with_block.html.erb`:
+```erb
+<%= render(ModalComponent) do |component| %>
+  <% component.with(:header) do %>
+    <span class="help_icon">Hello</span> 
+  <% end %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% end %>
+<% end %>
+```
+
+`app/views/no_header.html.erb`:
+```erb
+<%= render(ModalComponent) do |component| %>
+  <% component.with(:body) do %>
+    <p>Have a great day.</p>
+  <% end %>
+<% end %>
+```
+
 ### 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:
 
 ```ruby
-require "action_view/component/test_helpers"
+require "action_view/component/test_case"
 
-class MyComponentTest < Minitest::Test
-  include ActionView::Component::TestHelpers
-
-  def test_render_component
+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
@@ -207,7 +391,7 @@ In general, we’ve found it makes the most sense to test components based on th
 To test a specific variant you can wrap your test with the `with_variant` helper method as:
 
 ```ruby
-def test_render_component_for_tablet
+test "render component for tablet" do
   with_variant :tablet do
     assert_equal(
       %(<span title="my title">Hello, tablets!</span>),
@@ -218,7 +402,7 @@ end
 ```
 
 ### Previewing Components
-`ActionView::Component::Preview`s provide a way to see how components look by visiting a special URL that renders them.
+`ActionView::Component::Preview` provides a way to see how components look by visiting a special URL that renders them.
 In the previous example, the preview class for `TestComponent` would be called `TestComponentPreview` and located in `test/components/previews/test_component_preview.rb`.
 To see the preview of the component with a given title, implement a method that renders the component.
 You can define as many examples as you want:
@@ -260,6 +444,30 @@ 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"
 ```
 
+### Setting up RSpec
+
+If you're using RSpec, you can configure component specs to have access to test helpers. Add the following to
+`spec/rails_helper.rb`:
+
+```ruby
+require "action_view/component/test_helpers"
+
+RSpec.configure do |config|
+    # ...
+
+    # Ensure that the test helpers are available in component specs
+    config.include ActionView::Component::TestHelpers, type: :component
+end
+```
+
+Specs created by the generator should now have access to test helpers like `render_inline`.
+
+To use component previews, set the following in `config/application.rb`:
+
+```ruby
+config.action_view_component.preview_path = "#{Rails.root}/spec/components/previews"
+```
+
 ## Frequently Asked Questions
 
 ### Can I use other templating languages besides ERB?

data/actionview-component.gemspec

@@ -39,6 +39,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "minitest", "= 5.1.0"
   spec.add_development_dependency "haml", "~> 5"
   spec.add_development_dependency "slim", "~> 4.0"
+  spec.add_development_dependency "better_html", "~> 1"
   spec.add_development_dependency "rubocop", "= 0.74"
   spec.add_development_dependency "rubocop-github", "~> 0.13.0"
 end

data/lib/action_view/component.rb

@@ -1,5 +1,23 @@
 # frozen_string_literal: true
 
-require "action_view/component/monkey_patch"
-require "action_view/component/base"
+require "active_model"
+require "action_view"
+require "active_support/dependencies/autoload"
 require "action_view/component/railtie"
+
+module ActionView
+  module Component
+    extend ActiveSupport::Autoload
+
+    autoload :Base
+    autoload :Conversion
+    autoload :Preview
+    autoload :Previewable
+    autoload :TestHelpers
+    autoload :TestCase
+    autoload :RenderMonkeyPatch
+    autoload :TemplateError
+  end
+end
+
+ActiveModel::Conversion.include ActionView::Component::Conversion

data/lib/action_view/component/base.rb

@@ -1,20 +1,18 @@
 # frozen_string_literal: true
 
-require "active_model"
-require "action_view"
 require "active_support/configurable"
-require_relative "preview"
 
 module ActionView
   module Component
     class Base < ActionView::Base
       include ActiveModel::Validations
       include ActiveSupport::Configurable
-      include ActionView::Component::Previews
+      include ActionView::Component::Previewable
 
       delegate :form_authenticity_token, :protect_against_forgery?, to: :helpers
 
-      validate :variant_exists
+      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.
       #
@@ -42,7 +40,7 @@ module ActionView
       # <span title="greeting">Hello, world!</span>
       #
       def render_in(view_context, *args, &block)
-        self.class.compile
+        self.class.compile!
         @view_context = view_context
         @view_renderer ||= view_context.view_renderer
         @lookup_context ||= view_context.lookup_context
@@ -52,7 +50,8 @@ module ActionView
         old_current_template = @current_template
         @current_template = self
 
-        @content = view_context.capture(&block) if block_given?
+        @content = view_context.capture(self, &block) if block_given?
+
         validate!
 
         send(self.class.call_method_name(@variant))
@@ -92,14 +91,21 @@ module ActionView
         @variant
       end
 
-      private
+      def with(area, content = nil, &block)
+        unless content_areas.include?(area)
+          raise ArgumentError.new "Unknown content_area '#{area}' - expected one of '#{content_areas}'"
+        end
 
-      def variant_exists
-        return if self.class.variants.include?(@variant) || @variant.nil?
+        if block_given?
+          content = view_context.capture(&block)
+        end
 
-        errors.add(:variant, "'#{@variant}' has no template defined")
+        instance_variable_set("@#{area}".to_sym, content)
+        nil
       end
 
+      private
+
       def request
         @request ||= controller.request
       end
@@ -114,7 +120,7 @@ module ActionView
         end
 
         def call_method_name(variant)
-          if variant.present?
+          if variant.present? && variants.include?(variant)
             "call_#{variant}"
           else
             "call"
@@ -122,25 +128,39 @@ module ActionView
         end
 
         def source_location
-          # 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.
-          raise NotImplementedError.new("#{self} must implement #initialize.") unless self.instance_method(:initialize).owner == self
+          @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.
+                #
+                initialize_method = instance_method(:initialize)
+                initialize_method.source_location[0] if initialize_method.owner == self
+              end
+        end
+
+        def compiled?
+          @compiled && ActionView::Base.cache_template_loading
+        end
 
-          instance_method(:initialize).source_location[0]
+        def compile!
+          compile(validate: true)
         end
 
         # Compile templates to instance methods, assuming they haven't been compiled already.
         # We could in theory do this on app boot, at least in production environments.
         # Right now this just compiles the first time the component is rendered.
-        def compile
-          return if @compiled && ActionView::Base.cache_template_loading
+        def compile(validate: false)
+          return if compiled?
 
-          validate_templates
+          if template_errors.present?
+            raise ActionView::Component::TemplateError.new(template_errors) if validate
+            return false
+          end
 
           templates.each do |template|
             class_eval <<-RUBY, __FILE__, __LINE__ + 1
@@ -164,36 +184,59 @@ module ActionView
         end
 
         def identifier
-          ""
+          source_location
+        end
+
+        def with_content_areas(*areas)
+          if areas.include?(:content)
+            raise ArgumentError.new ":content is a reserved content area name. Please use another name, such as ':body'"
+          end
+          attr_reader *areas
+          self.content_areas = areas
         end
 
         private
 
+        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])
+        end
+
         def templates
           @templates ||=
-            (Dir["#{source_location.sub(/#{File.extname(source_location)}$/, '')}.*{#{ActionView::Template.template_handler_extensions.join(',')}}"] - [source_location]).each_with_object([]) do |path, memo|
+            matching_views_in_source_location.each_with_object([]) do |path, memo|
+              pieces = File.basename(path).split(".")
+
               memo << {
                 path: path,
-                variant: path.split(".").second.split("+")[1]&.to_sym,
-                handler: path.split(".").last
+                variant: pieces.second.split("+").second&.to_sym,
+                handler: pieces.last
               }
             end
         end
 
-        def validate_templates
-          if templates.empty?
-            raise NotImplementedError.new("Could not find a template file for #{self}.")
-          end
+        def template_errors
+          @template_errors ||=
+            begin
+              errors = []
+              errors << "#{self} must implement #initialize." if source_location.nil?
+              errors << "Could not find a template file for #{self}." if templates.empty?
 
-          if templates.select { |template| template[:variant].nil? }.length > 1
-            raise StandardError.new("More than one template found for #{self}. There can only be one default template file per component.")
-          end
+              if templates.count { |template| template[:variant].nil? } > 1
+                errors << "More than one template found for #{self}. There can only be one default template file per component."
+              end
 
-          variants.each_with_object(Hash.new(0)) { |variant, counts| counts[variant] += 1 }.each do |variant, count|
-            next unless count > 1
+              invalid_variants = templates
+                                   .group_by { |template| template[:variant] }
+                                   .map { |variant, grouped| variant if grouped.length > 1 }
+                                   .compact
+                                   .sort
 
-            raise StandardError.new("More than one template found for variant '#{variant}' in #{self}. There can only be one template file per variant.")
-          end
+              unless invalid_variants.empty?
+                errors << "More than one template found for #{'variant'.pluralize(invalid_variants.count)} #{invalid_variants.map { |v| "'#{v}'" }.to_sentence} in #{self}. There can only be one template file per variant."
+              end
+              errors
+            end
         end
 
         def compiled_template(file_path)

data/lib/action_view/component/conversion.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActionView
+  module Component # :nodoc:
+    module Conversion
+      def to_component_class
+        "#{self.class.name}Component".safe_constantize
+      end
+    end
+  end
+end

data/lib/action_view/component/preview.rb

@@ -1,37 +1,15 @@
 # frozen_string_literal: true
 
-require "active_support/concern"
 require "active_support/descendants_tracker"
-require_relative "test_helpers"
 
 module ActionView
-  module Component #:nodoc:
-    module Previews
-      extend ActiveSupport::Concern
-
-      included do
-        # Set the location of component previews through app configuration:
-        #
-        #     config.action_view_component.preview_path = "#{Rails.root}/lib/component_previews"
-        #
-        mattr_accessor :preview_path, instance_writer: false
-
-        # Enable or disable component previews through app configuration:
-        #
-        #     config.action_view_component.show_previews = true
-        #
-        # Defaults to +true+ for development environment
-        #
-        mattr_accessor :show_previews, instance_writer: false
-      end
-    end
-
+  module Component # :nodoc:
     class Preview
       extend ActiveSupport::DescendantsTracker
       include ActionView::Component::TestHelpers
 
-      def render(component, *locals)
-        render_inline(component, *locals)
+      def render(component, *locals, &block)
+        render_inline(component, *locals, &block)
       end
 
       class << self
@@ -42,11 +20,14 @@ module ActionView
         end
 
         # Returns the html of the component in its layout
-        def call(example)
+        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 || "layouts/application",
+                                                    layout: layout,
                                                     assigns: { example: example_html })
         end
 

data/lib/action_view/component/previewable.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require "active_support/concern"
+
+module ActionView
+  module Component # :nodoc:
+    module Previewable
+      extend ActiveSupport::Concern
+
+      included do
+        # Set the location of component previews through app configuration:
+        #
+        #     config.action_view_component.preview_path = "#{Rails.root}/lib/component_previews"
+        #
+        mattr_accessor :preview_path, instance_writer: false
+
+        # Enable or disable component previews through app configuration:
+        #
+        #     config.action_view_component.show_previews = true
+        #
+        # Defaults to +true+ for development environment
+        #
+        mattr_accessor :show_previews, instance_writer: false
+      end
+    end
+  end
+end

data/lib/action_view/component/railtie.rb

@@ -1,18 +1,13 @@
 # frozen_string_literal: true
 
-require "railties/lib/rails/components_controller"
-require "railties/lib/rails/component_examples_controller"
+require "rails"
+require "action_view/component"
 
 module ActionView
   module Component
     class Railtie < Rails::Railtie # :nodoc:
       config.action_view_component = ActiveSupport::OrderedOptions.new
 
-      # Disabled due to issues with ActionView::Component::Base not defining .logger
-      # initializer "action_view_component.logger" do
-      #   ActiveSupport.on_load(:action_view_component) { self.logger ||= Rails.logger }
-      # end
-
       initializer "action_view_component.set_configs" do |app|
         options = app.config.action_view_component
 
@@ -28,6 +23,9 @@ module ActionView
       end
 
       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
 
         if options.show_previews && options.preview_path
@@ -35,18 +33,23 @@ module ActionView
         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
 
-      # Disabled because `ActionView::Component::Base` doesn't implement `#action_methods`
-      # initializer "action_view_component.eager_load_actions" do
-      #   ActiveSupport.on_load(:after_initialize) do
-      #     ActionView::Component::Base.descendants.each(&:action_methods) if config.eager_load
-      #   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

data/lib/action_view/component/render_monkey_patch.rb

@@ -0,0 +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)
+          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."
+          )
+
+          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)
+          options[:component].new(options[:locals]).render_in(self, &block)
+        elsif options.respond_to?(:to_component_class) && !options.to_component_class.nil?
+          options.to_component_class.new(options).render_in(self, &block)
+        else
+          super
+        end
+      end
+    end
+  end
+end

data/lib/action_view/component/template_error.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ActionView
+  module Component
+    class TemplateError < StandardError
+      def initialize(errors)
+        super(errors.join(", "))
+      end
+    end
+  end
+end

data/lib/action_view/component/test_case.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+require "active_support/test_case"
+
+module ActionView
+  module Component
+    class TestCase < ActiveSupport::TestCase
+      include ActionView::Component::TestHelpers
+    end
+  end
+end

data/lib/action_view/component/test_helpers.rb

@@ -4,7 +4,7 @@ module ActionView
   module Component
     module TestHelpers
       def render_inline(component, **args, &block)
-        Nokogiri::HTML(controller.view_context.render(component, args, &block)).css("body > *")
+        Nokogiri::HTML.fragment(controller.view_context.render(component, args, &block))
       end
 
       def controller

data/lib/action_view/component/version.rb

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

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

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Rspec
+  module Generators
+    class ComponentGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      def create_test_file
+        template "component_spec.rb", File.join("spec/components", "#{file_name}_component_spec.rb")
+      end
+
+      private
+
+      def file_name
+        @_file_name ||= super.sub(/_component\z/i, "")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,13 @@
+require "rails_helper"
+
+RSpec.describe <%= class_name %>Component, type: :component do
+  pending "add some examples to (or delete) #{__FILE__}"
+
+  # it "renders something useful" do
+  #   expect(
+  #     render_inline(described_class, attr: "value") { "Hello, components!" }.css("p").to_html
+  #   ).to include(
+  #     "Hello, components!"
+  #   )
+  # end
+end

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

@@ -1,12 +1,10 @@
 require "test_helper"
 
-class <%= class_name %>ComponentTest < ActiveSupport::TestCase
-  include ActionView::Component::TestHelpers
-
+class <%= class_name %>ComponentTest < ActionView::Component::TestCase
   test "component renders something useful" do
     # assert_equal(
     #   %(<span title="my title">Hello, components!</span>),
-    #   render_inline(<%= class_name %>, attr: "value") { "Hello, components!" }.css("span").to_html
+    #   render_inline(<%= class_name %>Component, attr: "value") { "Hello, components!" }.css("span").to_html
     # )
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 1.5.2
+  version: 1.7.0
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-22 00:00:00.000000000 Z
+date: 2020-01-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '4.0'
+- !ruby/object:Gem::Dependency
+  name: better_html
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
@@ -115,6 +129,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/ISSUE_TEMPLATE"
+- ".github/PULL_REQUEST_TEMPLATE"
 - ".github/workflows/ruby_on_rails.yml"
 - ".gitignore"
 - ".rubocop.yml"
@@ -129,15 +145,21 @@ files:
 - actionview-component.gemspec
 - lib/action_view/component.rb
 - lib/action_view/component/base.rb
-- lib/action_view/component/monkey_patch.rb
+- lib/action_view/component/conversion.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/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/rspec/component_generator.rb
+- lib/rails/generators/rspec/templates/component_spec.rb.tt
 - lib/rails/generators/test_unit/component_generator.rb
 - lib/rails/generators/test_unit/templates/component_test.rb.tt
 - lib/railties/lib/rails.rb

data/lib/action_view/component/monkey_patch.rb

@@ -1,27 +0,0 @@
-# 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.
-class ActionView::Base
-  module RenderMonkeyPatch
-    def render(options = {}, args = {}, &block)
-      if options.respond_to?(:render_in)
-        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."
-        )
-
-        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)
-        options[:component].new(options[:locals]).render_in(self, &block)
-      else
-        super
-      end
-    end
-  end
-
-  prepend RenderMonkeyPatch
-end