Merge pull request #2353 from ViewComponent/2188-config

add configuration page to docs

Author: joelhawksley

docs/CHANGELOG.md

@@ -18,6 +18,10 @@ nav_order: 6
 
     *Joel Hawksley*
 
+* BREAKING: Rename `config.generate.component_parent_class` to `config.generate.parent_class`.
+
+    *Joel Hawksley*
+
 * Fix bug where `config.previews.enabled` did not function properly in production environments.
 
     *Joel Hawksley*

docs/api.md

@@ -275,12 +275,6 @@ A custom default layout used for the previews index page and individual previews
 
     config.view_component.previews.default_layout = "preview_layout"
 
-### `.test_controller`
-
-The controller used for testing components.
-Can also be configured on a per-test basis using `#with_controller_class`.
-Defaults to `ApplicationController`.
-
 ## ViewComponent::TestHelpers
 
 ### `#render_in_view_context(...)`

docs/guide/configuration.md

@@ -0,0 +1,19 @@
+---
+layout: default
+title: Configuration
+parent: How-to guide
+---
+
+# Configuration
+
+To configure ViewComponent, set options in `config/ENVIRONMENT.rb`:
+
+```ruby
+MyApplication.configure do
+  config.view_component.instrumentation_enabled = true
+  config.view_component.generate.path = "app/custom_components"
+  config.view_component.previews.controller = "MyPreviewController"
+end
+```
+
+For a list of available options, see [/api](/api#configuration).

docs/guide/generators.md

@@ -192,7 +192,7 @@ bin/rails generate view_component:component Example title content --parent MyBas
       create    app/components/example_component.html.erb
 ```
 
-To always use a specific parent class, set `config.view_component.component_parent_class = "MyBaseComponent"`.
+To always use a specific parent class, set `config.view_component.parent_class = "MyBaseComponent"`.
 
 ### Skip collision check
 

lib/generators/view_component/component/component_generator.rb

@@ -43,7 +43,7 @@ def create_component_file
       def parent_class
         return options[:parent] if options[:parent]
 
-        ViewComponent::Base.config.generate.component_parent_class || default_parent_class
+        ViewComponent::Base.config.generate.parent_class || default_parent_class
       end
 
       def initialize_signature?

lib/view_component/base.rb

@@ -441,12 +441,12 @@ def safe_output_postamble
     #
     #  Defaults to `false`.
     #
-    # #### component_parent_class
+    # #### ßparent_class
     #
     # Parent class for generated components
     #
     # ```ruby
-    # config.view_component.generate.component_parent_class = "MyBaseComponent"
+    # config.view_component.generate.parent_class = "MyBaseComponent"
     # ```
     #
     # Defaults to nil. If this is falsy, generators will use

lib/view_component/config.rb

@@ -128,12 +128,6 @@ def defaults
       # Whether ActiveSupport notifications are enabled.
       # Defaults to `false`.
 
-      # @!attribute test_controller
-      # @return [String]
-      # The controller used for testing components.
-      # Can also be configured on a per-test basis using `#with_controller_class`.
-      # Defaults to `ApplicationController`.
-
       def default_preview_paths
         (default_rails_preview_paths + default_rails_engines_preview_paths).uniq
       end

lib/view_component/configurable.rb

@@ -5,7 +5,7 @@ module Configurable
     extend ActiveSupport::Concern
 
     included do
-      next if respond_to?(:config) && config.respond_to?(:view_component) && config.respond_to_missing?(:test_controller)
+      next if respond_to?(:config) && config.respond_to?(:view_component) && config.respond_to_missing?(:instrumentation_enabled)
 
       include ActiveSupport::Configurable
 

test/sandbox/test/generators/component_generator_test.rb

@@ -96,8 +96,8 @@ def test_component_with_parent_and_application_component_class
     end
   end
 
-  def test_component_with_parent_and_custom_component_parent_class
-    with_custom_component_parent_class("MyBaseComponent") do
+  def test_component_with_parent_and_custom_parent_class
+    with_custom_parent_class("MyBaseComponent") do
       run_generator %w[user --parent MyOtherBaseComponent]
 
       assert_file "app/components/user_component.rb" do |component|
@@ -181,8 +181,8 @@ def test_generating_components_with_application_component_class
     end
   end
 
-  def test_generating_components_with_custom_component_parent_class
-    with_custom_component_parent_class("MyBaseComponent") do
+  def test_generating_components_with_custom_parent_class
+    with_custom_parent_class("MyBaseComponent") do
       run_generator %w[user]
 
       assert_file "app/components/user_component.rb" do |component|
@@ -194,7 +194,7 @@ def test_generating_components_with_custom_component_parent_class
 
   def test_generating_components_with_application_component_class_and_custom_parent_class
     with_application_component_class do
-      with_custom_component_parent_class("MyBaseComponent") do
+      with_custom_parent_class("MyBaseComponent") do
         run_generator %w[user]
 
         assert_file "app/components/user_component.rb" do |component|

test/test_helper.rb

@@ -95,8 +95,8 @@ def with_custom_component_path(new_value, &block)
   with_generate_option(:path, new_value, &block)
 end
 
-def with_custom_component_parent_class(new_value, &block)
-  with_generate_option(:component_parent_class, new_value, &block)
+def with_custom_parent_class(new_value, &block)
+  with_generate_option(:parent_class, new_value, &block)
 end
 
 def with_application_component_class