Use ViewComponent::Base.config as the internal endpoint for config (#1466)

* Use ViewComponent::Base.config as the internal endpoint for config

Tests are in place to ensure that Rails.application.config.view_component
refers to the same thing.

* Ensure we're testing configs both ways around

* Update changelog

* Lint

Author: boardfish

app/controllers/concerns/view_component/preview_actions.rb

@@ -43,12 +43,12 @@ def previews
 
     # :doc:
     def default_preview_layout
-      Rails.application.config.view_component.default_preview_layout
+      ViewComponent::Base.config.default_preview_layout
     end
 
     # :doc:
     def show_previews?
-      Rails.application.config.view_component.show_previews
+      ViewComponent::Base.config.show_previews
     end
 
     # :doc:

app/helpers/preview_helper.rb

@@ -22,7 +22,7 @@ def find_template_data(lookup_context:, template_identifier:)
       # Fetch template source via finding it through preview paths
       # to accomodate source view when exclusively using templates
       # for previews for Rails < 6.1.
-      all_template_paths = Rails.application.config.view_component.preview_paths.map do |preview_path|
+      all_template_paths = ViewComponent::Base.config.preview_paths.map do |preview_path|
         Dir.glob("#{preview_path}/**/*")
       end.flatten
 

app/views/view_components/preview.html.erb

@@ -1,5 +1,5 @@
 <% if @render_args[:component] %>
-  <% if Rails.application.config.view_component.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
+  <% if ViewComponent::Base.config.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
     <%= render(@render_args[:component], @render_args[:args], &@render_args[:block]) %>
   <% else %>
     <%= render_component(@render_args[:component], &@render_args[:block]) %>
@@ -8,6 +8,6 @@
   <%= render template: @render_args[:template], locals: @render_args[:locals] || {} %>
 <% end %>
 
-<% if Rails.application.config.view_component.show_previews_source %>
+<% if ViewComponent::Base.config.show_previews_source %>
   <%= preview_source %>
 <% end %>

docs/CHANGELOG.md

@@ -9,6 +9,10 @@ title: Changelog
 
 ## main
 
+* Use ViewComponent::Base.config as the internal endpoint for config.
+
+    *Simon Fish*
+
 * Fix bug where `#with_request_url`, when used with query string, set the incorrect `request.path` and `request.fullpath`.
 
     *Franz Liedke*

lib/rails/generators/abstract_generator.rb

@@ -29,7 +29,7 @@ def file_name
     end
 
     def component_path
-      Rails.application.config.view_component.view_component_path
+      ViewComponent::Base.config.view_component_path
     end
 
     def stimulus_controller
@@ -42,7 +42,7 @@ def stimulus_controller
     end
 
     def sidecar?
-      options["sidecar"] || Rails.application.config.view_component.generate.sidecar
+      options["sidecar"] || ViewComponent::Base.config.generate.sidecar
     end
   end
 end

lib/rails/generators/component/component_generator.rb

@@ -13,12 +13,12 @@ class ComponentGenerator < Rails::Generators::NamedBase
       check_class_collision suffix: "Component"
 
       class_option :inline, type: :boolean, default: false
-      class_option :locale, type: :boolean, default: Rails.application.config.view_component.generate.locale
+      class_option :locale, type: :boolean, default: ViewComponent::Base.config.generate.locale
       class_option :parent, type: :string, desc: "The parent class for the generated component"
-      class_option :preview, type: :boolean, default: Rails.application.config.view_component.generate.preview
+      class_option :preview, type: :boolean, default: ViewComponent::Base.config.generate.preview
       class_option :sidecar, type: :boolean, default: false
       class_option :stimulus, type: :boolean,
-        default: Rails.application.config.view_component.generate.stimulus_controller
+        default: ViewComponent::Base.config.generate.stimulus_controller
 
       def create_component_file
         template "component.rb", File.join(component_path, class_path, "#{file_name}_component.rb")
@@ -41,7 +41,7 @@ def create_component_file
       def parent_class
         return options[:parent] if options[:parent]
 
-        Rails.application.config.view_component.component_parent_class || default_parent_class
+        ViewComponent::Base.config.component_parent_class || default_parent_class
       end
 
       def initialize_signature

lib/rails/generators/locale/component_generator.rb

@@ -12,7 +12,7 @@ class ComponentGenerator < ::Rails::Generators::NamedBase
       class_option :sidecar, type: :boolean, default: false
 
       def create_locale_file
-        if Rails.application.config.view_component.generate.distinct_locale_files
+        if ViewComponent::Base.config.generate.distinct_locale_files
           I18n.available_locales.each do |locale|
             create_file destination(locale), translations_hash([locale]).to_yaml
           end

lib/rails/generators/preview/component_generator.rb

@@ -9,7 +9,7 @@ class ComponentGenerator < ::Rails::Generators::NamedBase
       check_class_collision suffix: "ComponentPreview"
 
       def create_preview_file
-        preview_paths = Rails.application.config.view_component.preview_paths
+        preview_paths = ViewComponent::Base.config.preview_paths
         return if preview_paths.count > 1
 
         path_prefix = preview_paths.one? ? preview_paths.first : "test/components/previews"

lib/view_component/base.rb

@@ -18,7 +18,7 @@ class << self
       delegate(*ViewComponent::Config.defaults.keys, to: :config)
 
       def config
-        Rails.application.config.view_component
+        @config ||= ViewComponent::Config.defaults
       end
     end
 
@@ -496,7 +496,7 @@ def render_template_for(variant = nil)
 
         # Removes the first part of the path and the extension.
         child.virtual_path = child.source_location.gsub(
-          /(.*#{Regexp.quote(Rails.application.config.view_component.view_component_path)})|(\.rb)/, ""
+          /(.*#{Regexp.quote(ViewComponent::Base.config.view_component_path)})|(\.rb)/, ""
         )
 
         # Set collection parameter to the extended component

lib/view_component/engine.rb

@@ -5,7 +5,7 @@
 
 module ViewComponent
   class Engine < Rails::Engine # :nodoc:
-    config.view_component = ViewComponent::Config.default
+    config.view_component = ViewComponent::Base.config
 
     rake_tasks do
       load "view_component/rails/tasks/view_component.rake"