Centralize ViewComponent::Base config (#1291)

* Update changelog

* Clean up mirrored config options from ViewComponent::Base

* Refactor generate test helper

* Test that app config and ViewComponent::Base config are equivalent

* Update documentation on defaults

* Update lib/view_component/base.rb

Co-authored-by: Hans Lemuet <Spone@users.noreply.github.com>

* Create dedicated config object

* Move default config to constant

* Test to ensure preview_path alias is maintained

* Use OrderedOptions for generate config option to maintain behavior

* Update some defaults

* Remove duplicate config definitions

These are specified in ViewComponent::Config now.

* Clarify necessity of specifying preview paths

* Delegate the majority of config options back to application config

* Move remainder of Previewable accessors to app config

* Extract out default preview paths

* Make all config accessors accessible on ViewComponent::Base by default

* Remove the Previewable module

ALl it did was make preview-related config accessible on ViewComponent::Base

* Add default_preview_layout to global config

* Run `bundle update`

* Make ViewComponent::Base the source of truth for config

* Add backwards compatibility for config_accessor defaults

* Restore documentation for config options

* Improve test coverage

* Directly require ViewComponent::Base to fix Primer CI

* Directly require ViewComponent::Config to fix Primer CI

* Move config require to ViewComponent::Base

* Require ViewComponent::Deprecation in Config

* Add missing defaults

* Reset default_preview_layout to `nil`

* Remove all changes to docs/api.md

* Add code ownership

* s/with_generate/with_generate_option/

* Explain alias between .default and .new

* Draft test to ensure all config options are documented

The pieces are in place, but I think the final aim is that everything
for which there's a default and/or a reader is documented

* Ensure accessors defined in public methods are considered too

* Coerce to string for backwards compatibility

* Lint

* Use Ruby 3.0.3

* Add more detailed changelog message

Co-authored-by: Joel Hawksley <joel@hawksley.org>

* Manually restore the Previewable changes after rebase

* Lint

* Remove global output buffer option

* Remove previewable module

Config options for preview are now under ViewComponent::Config.

* Make Rails.application.config.view_component the source of truth

ViewComponent::Base should continue to work but will delegate back to that.

* Update missed stub

* Update Gemfile.lock

* Compose around ActiveSupport::OrderedOptions

Co-authored-by: Hans Lemuet <Spone@users.noreply.github.com>
Co-authored-by: Joel Hawksley <joel@hawksley.org>

Author: 3 people

.github/CODEOWNERS

@@ -26,7 +26,6 @@
 /app/**/* @juanmanuelramallo
 /docs/guide/previews.md @juanmanuelramallo
 /lib/view_component/preview.rb @juanmanuelramallo
-/lib/view_component/previewable.rb @juanmanuelramallo
 /lib/view_component/preview_template_error.rb @juanmanuelramallo
 /test/sandbox/test/components/previews/preview_source_from_layout_component_preview.rb @juanmanuelramallo
 /test/view_component/default_preview_layout_integration_test.rb @juanmanuelramallo
@@ -46,3 +45,5 @@
 /script/replicate-bug @boardfish
 /lib/view_component/docs_builder_component.rb @boardfish
 /lib/view_component/docs_builder_component.html.erb @boardfish
+/lib/view_component/config.rb @boardfish
+/test/view_component/config_test.rb @boardfish

Rakefile

@@ -70,9 +70,7 @@ namespace :docs do
 
     instance_methods_to_document = meths.select { |method| method.scope != :class }
     class_methods_to_document = meths.select { |method| method.scope == :class }
-    configuration_methods_to_document = registry.get("ViewComponent::Base").meths.select { |method|
-      method[:mattr_accessor]
-    }
+    configuration_methods_to_document = registry.get("ViewComponent::Config").meths.select(&:reader?)
     test_helper_methods_to_document = registry
       .get("ViewComponent::TestHelpers")
       .meths

app/controllers/concerns/view_component/preview_actions.rb

@@ -10,9 +10,7 @@ module PreviewActions
       around_action :set_locale, only: :previews
       before_action :require_local!, unless: :show_previews?
 
-      if respond_to?(:content_security_policy)
-        content_security_policy(false)
-      end
+      content_security_policy(false) if respond_to?(:content_security_policy)
     end
 
     def index
@@ -45,18 +43,18 @@ def previews
 
     # :doc:
     def default_preview_layout
-      ViewComponent::Base.default_preview_layout
+      Rails.application.config.view_component.default_preview_layout
     end
 
     # :doc:
     def show_previews?
-      ViewComponent::Base.show_previews
+      Rails.application.config.view_component.show_previews
     end
 
     # :doc:
     def find_preview
       candidates = []
-      params[:path].to_s.scan(%r{/|$}) { candidates << $` }
+      params[:path].to_s.scan(%r{/|$}) { candidates << Regexp.last_match.pre_match }
       preview = candidates.detect { |candidate| ViewComponent::Preview.exists?(candidate) }
 
       if preview
@@ -66,10 +64,8 @@ def find_preview
       end
     end
 
-    def set_locale
-      I18n.with_locale(params[:locale] || I18n.default_locale) do
-        yield
-      end
+    def set_locale(&block)
+      I18n.with_locale(params[:locale] || I18n.default_locale, &block)
     end
 
     # Returns either {} or {layout: value} depending on configuration

app/helpers/preview_helper.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 module PreviewHelper
-  AVAILABLE_PRISM_LANGUAGES = ["ruby", "erb", "haml"]
+  AVAILABLE_PRISM_LANGUAGES = %w[ruby erb haml]
   FALLBACK_LANGUAGE = "ruby"
 
   def preview_source
@@ -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 = ViewComponent::Base.preview_paths.map do |preview_path|
+      all_template_paths = Rails.application.config.view_component.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 ViewComponent::Base.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
+  <% if Rails.application.config.view_component.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 ViewComponent::Base.show_previews_source %>
+<% if Rails.application.config.view_component.show_previews_source %>
   <%= preview_source %>
 <% end %>

docs/CHANGELOG.md

@@ -9,6 +9,10 @@ title: Changelog
 
 ## main
 
+* Add missing `generate.sidecar`, `generate.stimulus_controller`, `generate.locale`, `generate.distinct_locale_files`, `generate.preview` config options to `config.view_component`.
+
+    *Simon Fish*
+
 ## 2.65.0
 
 * Raise `ArgumentError` when conflicting Slots are defined.

lib/rails/generators/abstract_generator.rb

@@ -3,9 +3,7 @@
 module ViewComponent
   module AbstractGenerator
     def copy_view_file
-      unless options["inline"]
-        template "component.html.#{engine_name}", destination
-      end
+      template "component.html.#{engine_name}", destination unless options["inline"]
     end
 
     private
@@ -31,7 +29,7 @@ def file_name
     end
 
     def component_path
-      ViewComponent::Base.view_component_path
+      Rails.application.config.view_component.view_component_path
     end
 
     def stimulus_controller
@@ -44,7 +42,7 @@ def stimulus_controller
     end
 
     def sidecar?
-      options["sidecar"] || ViewComponent::Base.generate.sidecar
+      options["sidecar"] || Rails.application.config.view_component.generate.sidecar
     end
   end
 end

lib/rails/generators/component/component_generator.rb

@@ -13,11 +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: ViewComponent::Base.generate.locale
+      class_option :locale, type: :boolean, default: Rails.application.config.view_component.generate.locale
       class_option :parent, type: :string, desc: "The parent class for the generated component"
-      class_option :preview, type: :boolean, default: ViewComponent::Base.generate.preview
+      class_option :preview, type: :boolean, default: Rails.application.config.view_component.generate.preview
       class_option :sidecar, type: :boolean, default: false
-      class_option :stimulus, type: :boolean, default: ViewComponent::Base.generate.stimulus_controller
+      class_option :stimulus, type: :boolean,
+        default: Rails.application.config.view_component.generate.stimulus_controller
 
       def create_component_file
         template "component.rb", File.join(component_path, class_path, "#{file_name}_component.rb")
@@ -40,7 +41,7 @@ def create_component_file
       def parent_class
         return options[:parent] if options[:parent]
 
-        ViewComponent::Base.component_parent_class || default_parent_class
+        Rails.application.config.view_component.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 ViewComponent::Base.generate.distinct_locale_files
+        if Rails.application.config.view_component.generate.distinct_locale_files
           I18n.available_locales.each do |locale|
             create_file destination(locale), translations_hash([locale]).to_yaml
           end

lib/view_component.rb

@@ -10,6 +10,7 @@ module ViewComponent
   autoload :Compiler
   autoload :CompileCache
   autoload :ComponentError
+  autoload :Config
   autoload :Deprecation
   autoload :Instrumentation
   autoload :Preview