actionview-component 1.3.5 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6dcbc0baecff7159dafaf87120583a68055e931c926679bd8b3300b54232c769
-  data.tar.gz: b5eda121857a5dd034457e1fda306bfb1fa1e666159d20729feaee2f2da699c1
+  metadata.gz: 30c2d62abc3a38ba7f383a934ea3a95d6e490f81868d062d9263130e6d694d84
+  data.tar.gz: 8cc4375853920bd79183e9e634e00a9f4804726c2fc2a60328f3f1ad664bccef
 SHA512:
-  metadata.gz: cf003dfb9c8dc68e7cef33e4c78fa947006b58ec076658586c95bece8a65e98516989cba81a58bcd632a1706c9b7b93b19bd51006b6f8291256dc0062ba4db1c
-  data.tar.gz: f7707687dee6494852ad1520154d57acff346f4fa6dcdb2bfc0e2f324ed4a4683fe7f2e3b8b1f3a69a38ff4dae0e0a72b53a7f73a3f524d0f7f6e9b07a625fd3
+  metadata.gz: 98e2021c3308374c1ef1d92d044b18bdcbb071e422a52cbfe102f984cbf34521d6c19b4f9b60b511f3f9ffa1e3b2e0fc7b5ec31dcf22420f5d4240baad42e881
+  data.tar.gz: 7e68770c3ec42381c7fce1028834b95ce4c6d04e1ce71e2849ce04a99b73b3539c2246c35bd77421a63c754e66fac083adaac1ae531bc37fb306293cd7a9a61e

data/.github/workflows/ruby_on_rails.yml

@@ -8,22 +8,18 @@ jobs:
     strategy:
       matrix:
         rails_version: [5.0.0, 5.2.3, 6.0.0, master]
-        ruby_version: [2.3.x, 2.4.x, 2.5.x, 2.6.x]
+        ruby_version: [2.4.x, 2.5.x, 2.6.x]
         exclude:
           - rails_version: master
             ruby_version: 2.4.x
-          - rails_version: master
-            ruby_version: 2.3.x
           - rails_version: 6.0.0
             ruby_version: 2.4.x
-          - rails_version: 6.0.0
-            ruby_version: 2.3.x
     steps:
     - uses: actions/checkout@master
     - name: Setup Ruby
       uses: actions/setup-ruby@v1
       with:
-        version: ${{ matrix.ruby_version }}
+        ruby-version: ${{ matrix.ruby_version }}
     - name: Build and test with Rake
       run: |
         gem install bundler:1.14.0

data/CHANGELOG.md

@@ -1,3 +1,67 @@
+# v1.5.2
+
+* Disable eager loading initializer.
+
+    *Kasper Meyer*
+
+# v1.5.1
+
+* Update railties class to work with Rails 6.
+
+    *Juan Manuel Ramallo*
+
+# v1.5.0
+
+Note: `actionview-component` is now loaded by requiring `actionview/component`, not `actionview/component/base`.
+
+* Fix issue with generating component method signatures.
+
+    *Ryan Workman, Dylan Clark*
+
+* Create component generator.
+
+    *Vinicius Stock*
+
+* Add helpers proxy.
+
+    *Kasper Meyer*
+
+* Introduce ActionView::Component::Previews.
+
+    *Juan Manuel Ramallo*
+
+# v1.4.0
+
+* Fix bug where components broke in application paths with periods.
+
+    *Anton, Joel Hawksley*
+
+* Add support for `cache_if` in component templates.
+
+    *Aaron Patterson, Joel Hawksley*
+
+* Add support for variants.
+
+    *Juan Manuel Ramallo*
+
+* Fix bug in virtual path lookup.
+
+    *Juan Manuel Ramallo*
+
+* Preselect the rendered component in render_inline.
+
+    *Elia Schito*
+
+# v1.3.6
+
+* Allow template file names without format.
+
+    *Joel Hawksley*
+
+* Add support for translations.
+
+    *Juan Manuel Ramallo*
+
 # v1.3.5
 
 * Re-expose `controller` method.

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    actionview-component (1.3.5)
+    actionview-component (1.5.2)
 
 GEM
   remote: https://rubygems.org/
@@ -64,7 +64,7 @@ GEM
     ast (2.4.0)
     builder (3.2.3)
     concurrent-ruby (1.1.5)
-    crass (1.0.4)
+    crass (1.0.5)
     erubi (1.8.0)
     globalid (0.4.2)
       activesupport (>= 4.2.0)
@@ -74,7 +74,7 @@ GEM
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
     jaro_winkler (1.5.3)
-    loofah (2.2.3)
+    loofah (2.3.1)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     mail (2.7.1)
@@ -87,7 +87,7 @@ GEM
     mini_portile2 (2.4.0)
     minitest (5.1.0)
     nio4r (2.5.2)
-    nokogiri (1.10.4)
+    nokogiri (1.10.5)
       mini_portile2 (~> 2.4.0)
     parallel (1.17.0)
     parser (2.6.3.0)
@@ -168,7 +168,7 @@ DEPENDENCIES
   minitest (= 5.1.0)
   rails (= 6.0.0)
   rake (~> 10.0)
-  rubocop (~> 0.59)
+  rubocop (= 0.74)
   rubocop-github (~> 0.13.0)
   slim (~> 4.0)
 

data/README.md

@@ -15,7 +15,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.3`/`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.4`/`2.5`/`2.6` and Rails `5.0.0`/`5.2.3`/`6.0.0`/`6.1.0.alpha`.
 
 ## Installation
 Add this line to your application's Gemfile:
@@ -32,7 +32,7 @@ $ bundle
 In `config/application.rb`, add:
 
 ```bash
-require "action_view/component/base"
+require "action_view/component"
 ```
 
 ## Guide
@@ -97,10 +97,26 @@ Components are subclasses of `ActionView::Component::Base` and live in `app/comp
 
 Component class names end in -`Component`.
 
+Component module names are plural, as they are for controllers. (`Users::AvatarComponent`)
+
 Components support ActiveModel validations. Components are validated after initialization, but before rendering.
 
 Content passed to an `ActionView::Component` as a block is captured and assigned to the `content` accessor.
 
+#### Quick start
+
+Use the component generator to create a new `ActionView::Component`.
+
+The generator accepts the component name and the list of accepted properties as arguments:
+
+```bash
+bin/rails generate component Example title content
+      invoke  test_unit
+      create  test/components/example_component_test.rb
+      create  app/components/example_component.rb
+      create  app/components/example_component.html.erb
+```
+
 #### Implementation
 
 An `ActionView::Component` is a Ruby file and corresponding template file (in any format supported by Rails) with the same base name:
@@ -178,7 +194,7 @@ class MyComponentTest < Minitest::Test
   def test_render_component
     assert_equal(
       %(<span title="my title">Hello, World!</span>),
-      render_inline(TestComponent, title: "my title") { "Hello, World!" }.css("span").to_html
+      render_inline(TestComponent, title: "my title") { "Hello, World!" }.to_html
     )
   end
 end
@@ -186,6 +202,64 @@ end
 
 In general, we’ve found it makes the most sense to test components based on their rendered HTML.
 
+#### Action Pack Variants
+
+To test a specific variant you can wrap your test with the `with_variant` helper method as:
+
+```ruby
+def test_render_component_for_tablet
+  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
+    )
+  end
+end
+```
+
+### Previewing Components
+`ActionView::Component::Preview`s provide 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:
+
+```ruby
+# test/components/previews/test_component_preview.rb
+
+class TestComponentPreview < ActionView::Component::Preview
+  def with_default_title
+    render(TestComponent, 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")
+  end
+end
+```
+
+The previews will be available in <http://localhost:3000/rails/components/test_component/with_default_title>
+and <http://localhost:3000/rails/components/test_component/with_long_title>.
+
+Previews use the application layout by default, but you can also use other layouts from your app:
+
+```ruby
+# test/components/previews/test_component_preview.rb
+
+class TestComponentPreview < ActionView::Component::Preview
+  layout "admin"
+
+  ...
+end
+```
+
+By default, the preview classes live in `test/components/previews`.
+This can be configured using the `preview_path` option.
+For example, if you want to use `lib/component_previews`, set the following in `config/application.rb`:
+
+```ruby
+config.action_view_component.preview_path = "#{Rails.root}/lib/component_previews"
+```
+
 ## Frequently Asked Questions
 
 ### Can I use other templating languages besides ERB?

data/actionview-component.gemspec

@@ -39,6 +39,6 @@ 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 "rubocop", "~> 0.59"
+  spec.add_development_dependency "rubocop", "= 0.74"
   spec.add_development_dependency "rubocop-github", "~> 0.13.0"
 end

data/lib/action_view/component.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require "action_view/component/monkey_patch"
+require "action_view/component/base"
+require "action_view/component/railtie"

data/lib/action_view/component/base.rb

@@ -1,37 +1,20 @@
 # 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 to `render` 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
+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 ActionController::RequestForgeryProtection
+      include ActionView::Component::Previews
+
+      delegate :form_authenticity_token, :protect_against_forgery?, to: :helpers
+
+      validate :variant_exists
 
       # Entrypoint for rendering components. Called by ActionView::Base#render.
       #
@@ -64,10 +47,17 @@ module ActionView
         @view_renderer ||= view_context.view_renderer
         @lookup_context ||= view_context.lookup_context
         @view_flow ||= view_context.view_flow
+        @virtual_path ||= virtual_path
+        @variant = @lookup_context.variants.first
+        old_current_template = @current_template
+        @current_template = self
 
         @content = view_context.capture(&block) if block_given?
         validate!
-        call
+
+        send(self.class.call_method_name(@variant))
+      ensure
+        @current_template = old_current_template
       end
 
       def initialize(*); end
@@ -84,6 +74,38 @@ module ActionView
         @controller ||= view_context.controller
       end
 
+      # Provides a proxy to access helper methods through
+      def helpers
+        @helpers ||= view_context
+      end
+
+      # Removes the first part of the path and the extension.
+      def virtual_path
+        self.class.source_location.gsub(%r{(.*app/components)|(\.rb)}, "")
+      end
+
+      def view_cache_dependencies
+        []
+      end
+
+      def format # :nodoc:
+        @variant
+      end
+
+      private
+
+      def variant_exists
+        return if self.class.variants.include?(@variant) || @variant.nil?
+
+        errors.add(:variant, "'#{@variant}' has no template defined")
+      end
+
+      def request
+        @request ||= controller.request
+      end
+
+      attr_reader :content, :view_context
+
       class << self
         def inherited(child)
           child.include Rails.application.routes.url_helpers unless child < Rails.application.routes.url_helpers
@@ -91,80 +113,102 @@ module ActionView
           super
         end
 
-        # Compile template to #call instance method, assuming it hasn't been compiled already.
+        def call_method_name(variant)
+          if variant.present?
+            "call_#{variant}"
+          else
+            "call"
+          end
+        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
+
+          instance_method(:initialize).source_location[0]
+        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 template the first time the component is rendered.
+        # Right now this just compiles the first time the component is rendered.
         def compile
           return if @compiled && ActionView::Base.cache_template_loading
 
-          class_eval <<-RUBY, __FILE__, __LINE__ + 1
-            def call
-              @output_buffer = ActionView::OutputBuffer.new
-              #{compiled_template}
-            end
-          RUBY
+          validate_templates
+
+          templates.each do |template|
+            class_eval <<-RUBY, __FILE__, __LINE__ + 1
+              def #{call_method_name(template[:variant])}
+                @output_buffer = ActionView::OutputBuffer.new
+                #{compiled_template(template[:path])}
+              end
+            RUBY
+          end
 
           @compiled = true
         end
 
-        private
+        def variants
+          templates.map { |template| template[:variant] }
+        end
 
-        def compiled_template
-          handler = ActionView::Template.handler_for_extension(File.extname(template_file_path).gsub(".", ""))
-          template = File.read(template_file_path)
+        # we'll eventually want to update this to support other types
+        def type
+          "text/html"
+        end
 
-          if handler.method(:call).parameters.length > 1
-            handler.call(DummyTemplate.new, template)
-          else
-            handler.call(DummyTemplate.new(template))
-          end
+        def identifier
+          ""
         end
 
-        def template_file_path
-          raise NotImplementedError.new("#{self} must implement #initialize.") unless self.instance_method(:initialize).owner == self
+        private
 
-          filename = self.instance_method(:initialize).source_location[0]
-          filename_without_extension = filename[0..-(File.extname(filename).length + 1)]
-          sibling_template_files = Dir["#{filename_without_extension}.????.{#{ActionView::Template.template_handler_extensions.join(',')}}"] - [filename]
+        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|
+              memo << {
+                path: path,
+                variant: path.split(".").second.split("+")[1]&.to_sym,
+                handler: path.split(".").last
+              }
+            end
+        end
 
-          if sibling_template_files.length > 1
-            raise StandardError.new("More than one template found for #{self}. There can only be one sidecar template file per component.")
+        def validate_templates
+          if templates.empty?
+            raise NotImplementedError.new("Could not find a template file for #{self}.")
           end
 
-          if sibling_template_files.length == 0
-            raise NotImplementedError.new(
-              "Could not find a template file for #{self}."
-            )
+          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
 
-          sibling_template_files[0]
-        end
-      end
-
-      class DummyTemplate
-        attr_reader :source
+          variants.each_with_object(Hash.new(0)) { |variant, counts| counts[variant] += 1 }.each do |variant, count|
+            next unless count > 1
 
-        def initialize(source = nil)
-          @source = source
+            raise StandardError.new("More than one template found for variant '#{variant}' in #{self}. There can only be one template file per variant.")
+          end
         end
 
-        def identifier
-          ""
-        end
+        def compiled_template(file_path)
+          handler = ActionView::Template.handler_for_extension(File.extname(file_path).gsub(".", ""))
+          template = File.read(file_path)
 
-        # we'll eventually want to update this to support other types
-        def type
-          "text/html"
+          if handler.method(:call).parameters.length > 1
+            handler.call(self, template)
+          else # remove before upstreaming into Rails
+            handler.call(OpenStruct.new(source: template, identifier: identifier, type: type))
+          end
         end
       end
 
-      private
-
-      def request
-        @request ||= controller.request
-      end
-
-      attr_reader :content, :view_context
+      ActiveSupport.run_load_hooks(:action_view_component, self)
     end
   end
 end

data/lib/action_view/component/monkey_patch.rb

@@ -0,0 +1,27 @@
+# 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

data/lib/action_view/component/preview.rb

@@ -0,0 +1,106 @@
+# 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
+
+    class Preview
+      extend ActiveSupport::DescendantsTracker
+      include ActionView::Component::TestHelpers
+
+      def render(component, *locals)
+        render_inline(component, *locals)
+      end
+
+      class << self
+        # Returns all component preview classes.
+        def all
+          load_previews if descendants.empty?
+          descendants
+        end
+
+        # Returns the html of the component in its layout
+        def call(example)
+          example_html = new.public_send(example)
+
+          Rails::ComponentExamplesController.render(template: "examples/show",
+                                                    layout: @layout || "layouts/application",
+                                                    assigns: { example: example_html })
+        end
+
+        # Returns the component object class associated to the preview.
+        def component
+          self.name.sub(%r{Preview$}, "").constantize
+        end
+
+        # Returns all of the available examples for the component preview.
+        def examples
+          public_instance_methods(false).map(&:to_s).sort
+        end
+
+        # Returns +true+ if the example of the component preview exists.
+        def example_exists?(example)
+          examples.include?(example)
+        end
+
+        # Returns +true+ if the preview exists.
+        def exists?(preview)
+          all.any? { |p| p.preview_name == preview }
+        end
+
+        # Find a component preview by its underscored class name.
+        def find(preview)
+          all.find { |p| p.preview_name == preview }
+        end
+
+        # Returns the underscored name of the component preview without the suffix.
+        def preview_name
+          name.sub(/Preview$/, "").underscore
+        end
+
+        # Setter for layout name.
+        def layout(layout_name)
+          @layout = layout_name
+        end
+
+        private
+
+        def load_previews
+          if preview_path
+            Dir["#{preview_path}/**/*_preview.rb"].sort.each { |file| require_dependency file }
+          end
+        end
+
+        def preview_path
+          Base.preview_path
+        end
+
+        def show_previews
+          Base.show_previews
+        end
+      end
+    end
+  end
+end

data/lib/action_view/component/railtie.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+require "railties/lib/rails/components_controller"
+require "railties/lib/rails/component_examples_controller"
+
+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
+
+        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.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
+
+      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/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))
+        Nokogiri::HTML(controller.view_context.render(component, args, &block)).css("body > *")
       end
 
       def controller
@@ -22,6 +22,14 @@ module ActionView
 
         render_inline(component, args, &block)
       end
+
+      def with_variant(variant)
+        old_variants = controller.view_context.lookup_context.variants
+
+        controller.view_context.lookup_context.variants = variant
+        yield
+        controller.view_context.lookup_context.variants = old_variants
+      end
     end
   end
 end

data/lib/action_view/component/version.rb

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

data/lib/rails/generators/component/USAGE

@@ -0,0 +1,13 @@
+Description:
+============
+    Creates a new component and test.
+    Pass the component name, either CamelCased or under_scored, and an optional list of attributes as arguments.
+
+Example:
+========
+    bin/rails generate component Profile name age
+
+    creates a Profile component and test:
+        Component:    app/components/profile_component.rb
+        Template:     app/components/profile_component.html.erb
+        Test:         test/components/profile_component_test.rb

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

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Rails
+  module Generators
+    class ComponentGenerator < Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+
+      argument :attributes, type: :array, default: [], banner: "attribute"
+      hook_for :test_framework
+      check_class_collision suffix: "Component"
+
+      def create_component_file
+        template "component.rb", File.join("app/components",  "#{file_name}_component.rb")
+      end
+
+      def create_template_file
+        template "component.html.erb", File.join("app/components",  "#{file_name}_component.html.erb")
+      end
+
+      private
+
+      def file_name
+        @_file_name ||= super.sub(/_component\z/i, "")
+      end
+
+      def requires_content?
+        return @requires_content if @asked
+
+        @asked = true
+        @requires_content = ask("Would you like #{class_name} to require content? (Y/n)").downcase == "y"
+      end
+
+      def parent_class
+        defined?(ApplicationComponent) ? "ApplicationComponent" : "ActionView::Component::Base"
+      end
+
+      def initialize_signature
+        if attributes.present?
+          attributes.map { |attr| "#{attr.name}:" }.join(", ")
+        else
+          "*"
+        end
+      end
+
+      def initialize_body
+        attributes.map { |attr| "@#{attr.name} = #{attr.name}" }.join("\n    ")
+      end
+    end
+  end
+end

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

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

data/lib/rails/generators/component/templates/component.rb.tt

@@ -0,0 +1,9 @@
+class <%= class_name %>Component < <%= parent_class %>
+  <%- if requires_content? -%>
+  validates :content, presence: true
+  <%- end -%>
+
+  def initialize(<%= initialize_signature %>)
+    <%= initialize_body %>
+  end
+end

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

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module TestUnit
+  module Generators
+    class ComponentGenerator < ::Rails::Generators::NamedBase
+      source_root File.expand_path("templates", __dir__)
+      check_class_collision suffix: "ComponentTest"
+
+      def create_test_file
+        template "component_test.rb", File.join("test/components", "#{file_name}_component_test.rb")
+      end
+
+      private
+
+      def file_name
+        @_file_name ||= super.sub(/_component\z/i, "")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,12 @@
+require "test_helper"
+
+class <%= class_name %>ComponentTest < ActiveSupport::TestCase
+  include ActionView::Component::TestHelpers
+
+  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
+    # )
+  end
+end

data/lib/railties/lib/rails.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Rails
+  autoload :ComponentsController
+  autoload :ComponentExamplesController
+end

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

@@ -0,0 +1,9 @@
+# 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/components_controller.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+require "rails/application_controller"
+
+class Rails::ComponentsController < Rails::ApplicationController # :nodoc:
+  prepend_view_path File.expand_path("templates/rails", __dir__)
+
+  around_action :set_locale, only: :previews
+  before_action :find_preview, only: :previews
+  before_action :require_local!, unless: :show_previews?
+
+  if respond_to?(:content_security_policy)
+    content_security_policy(false)
+  end
+
+  def index
+    @previews = ActionView::Component::Preview.all
+    @page_title = "Component Previews"
+    render template: "components/index"
+  end
+
+  def previews
+    if params[:path] == @preview.preview_name
+      @page_title = "Component Previews for #{@preview.preview_name}"
+      render template: "components/previews"
+    else
+      @example_name = File.basename(params[:path])
+      render template: "components/preview", layout: false
+    end
+  end
+
+  private
+
+  def show_previews? # :doc:
+    ActionView::Component::Base.show_previews
+  end
+
+  def find_preview # :doc:
+    candidates = []
+    params[:path].to_s.scan(%r{/|$}) { candidates << $` }
+    preview = candidates.detect { |candidate| ActionView::Component::Preview.exists?(candidate) }
+
+    if preview
+      @preview = ActionView::Component::Preview.find(preview)
+    else
+      raise AbstractController::ActionNotFound, "Component preview '#{params[:path]}' not found"
+    end
+  end
+
+  def set_locale
+    I18n.with_locale(params[:locale] || I18n.default_locale) do
+      yield
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+<% @previews.each do |preview| %>
+  <h3><%= link_to preview.preview_name.titleize, "/rails/components/#{preview.preview_name}" %></h3>
+  <ul>
+    <% preview.examples.each do |preview_example| %>
+      <li><%= link_to preview_example, "/rails/components/#{preview.preview_name}/#{preview_example}" %></li>
+    <% end %>
+  </ul>
+<% end %>

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

@@ -0,0 +1 @@
+<%= raw @preview.call(@example_name) %>

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

@@ -0,0 +1,6 @@
+<h3><%= @preview.preview_name.titleize %></h3>
+<ul>
+  <% @preview.examples.each do |example| %>
+    <li><%= link_to example, "/rails/components/#{@preview.preview_name}/#{example}" %></li>
+  <% end %>
+</ul>

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

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: actionview-component
 version: !ruby/object:Gem::Version
-  version: 1.3.5
+  version: 1.5.2
 platform: ruby
 authors:
 - GitHub Open Source
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
+date: 2019-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -84,16 +84,16 @@ dependencies:
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '0.74'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0.59'
+        version: '0.74'
 - !ruby/object:Gem::Dependency
   name: rubocop-github
   requirement: !ruby/object:Gem::Requirement
@@ -127,9 +127,26 @@ files:
 - README.md
 - Rakefile
 - 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/preview.rb
+- lib/action_view/component/railtie.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/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