WIP: Extract strict_helpers_enabled? to component-local config

Rakefile

@@ -95,7 +95,7 @@ namespace :docs do
     require "rails"
     require "action_controller"
     require "view_component"
-    ViewComponent::Base.config.view_component_path = "view_component"
+    ViewComponent::GlobalConfig.view_component_path = "view_component"
     require "view_component/docs_builder_component"
 
     error_keys = registry.keys.select { |key| key.to_s.include?("Error::MESSAGE") }.map(&:to_s)

app/controllers/concerns/view_component/preview_actions.rb

@@ -47,12 +47,12 @@ def previews
 
     # :doc:
     def default_preview_layout
-      ViewComponent::Base.config.default_preview_layout
+      GlobalConfig.default_preview_layout
     end
 
     # :doc:
     def show_previews?
-      ViewComponent::Base.config.show_previews
+      GlobalConfig.show_previews
     end
 
     # :doc:
@@ -95,7 +95,7 @@ def prepend_application_view_paths
     end
 
     def prepend_preview_examples_view_path
-      prepend_view_path(ViewComponent::Base.preview_paths)
+      prepend_view_path(GlobalConfig.preview_paths)
     end
   end
 end

app/helpers/preview_helper.rb

@@ -35,7 +35,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.config.preview_paths.map do |preview_path|
+      all_template_paths = ViewComponent::GlobalConfig.preview_paths.map do |preview_path|
         Dir.glob("#{preview_path}/**/*")
       end.flatten
 
@@ -80,6 +80,6 @@ def prism_language_name_by_template_path(template_file_path:)
   # :nocov:
 
   def serve_static_preview_assets?
-    ViewComponent::Base.config.show_previews && Rails.application.config.public_file_server.enabled
+    ViewComponent::GlobalConfig.show_previews && Rails.application.config.public_file_server.enabled
   end
 end

app/views/view_components/preview.html.erb

@@ -1,5 +1,5 @@
 <% if @render_args[:component] %>
-  <% if ViewComponent::Base.config.render_monkey_patch_enabled || Rails.version.to_f >= 6.1 %>
+  <% if ViewComponent::GlobalConfig.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.config.show_previews_source %>
+<% if ViewComponent::GlobalConfig.show_previews_source %>
   <%= preview_source %>
 <% end %>

docs/CHANGELOG.md

@@ -10,6 +10,20 @@ nav_order: 5
 
 ## main
 
+* Add `helpers_enabled` config.
+
+    *Reegan Viljoen*
+
+* Include ViewComponent::UseHelpers by default.
+
+    *Reegan Viljoen*
+
+* Make accommodations for component-local config to be introduced in future.
+
+  BREAKING: Assigning to `ViewComponent::Base.config` will no longer work. Instead, assign to `Rails.application.config`.
+
+    *Simon Fish*
+
 * Use struct instead openstruct in lib code.
 
     *Oleksii Vasyliev*

lib/rails/generators/abstract_generator.rb

@@ -29,7 +29,7 @@ def file_name
     end
 
     def component_path
-      ViewComponent::Base.config.view_component_path
+      GlobalConfig.view_component_path
     end
 
     def stimulus_controller
@@ -42,15 +42,15 @@ def stimulus_controller
     end
 
     def sidecar?
-      options["sidecar"] || ViewComponent::Base.config.generate.sidecar
+      options["sidecar"] || GlobalConfig.generate.sidecar
     end
 
     def stimulus?
-      options["stimulus"] || ViewComponent::Base.config.generate.stimulus_controller
+      options["stimulus"] || GlobalConfig.generate.stimulus_controller
     end
 
     def typescript?
-      options["typescript"] || ViewComponent::Base.config.generate.typescript
+      options["typescript"] || GlobalConfig.generate.typescript
     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: ViewComponent::Base.config.generate.locale
+      class_option :locale, type: :boolean, default: ViewComponent::GlobalConfig.generate.locale
       class_option :parent, type: :string, desc: "The parent class for the generated component"
-      class_option :preview, type: :boolean, default: ViewComponent::Base.config.generate.preview
+      class_option :preview, type: :boolean, default: ViewComponent::GlobalConfig.generate.preview
       class_option :sidecar, type: :boolean, default: false
       class_option :stimulus, type: :boolean,
-        default: ViewComponent::Base.config.generate.stimulus_controller
+        default: ViewComponent::GlobalConfig.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]
 
-        ViewComponent::Base.config.component_parent_class || default_parent_class
+        ViewComponent::GlobalConfig.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.config.generate.distinct_locale_files
+        if ViewComponent::GlobalConfig.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

@@ -4,13 +4,13 @@ module Preview
   module Generators
     class ComponentGenerator < ::Rails::Generators::NamedBase
       source_root File.expand_path("templates", __dir__)
-      class_option :preview_path, type: :string, desc: "Path for previews, required when multiple preview paths are configured", default: ViewComponent::Base.config.generate.preview_path
+      class_option :preview_path, type: :string, desc: "Path for previews, required when multiple preview paths are configured", default: ViewComponent::GlobalConfig.generate.preview_path
 
       argument :attributes, type: :array, default: [], banner: "attribute"
       check_class_collision suffix: "ComponentPreview"
 
       def create_preview_file
-        preview_paths = ViewComponent::Base.config.preview_paths
+        preview_paths = ViewComponent::GlobalConfig.preview_paths
         optional_path = options[:preview_path]
         return if preview_paths.count > 1 && optional_path.blank?
 

lib/rails/generators/rspec/component_generator.rb

@@ -16,7 +16,7 @@ def create_test_file
       private
 
       def spec_component_path
-        return "spec/components" unless ViewComponent::Base.config.generate.use_component_path_for_rspec_tests
+        return "spec/components" unless ViewComponent::GlobalConfig.generate.use_component_path_for_rspec_tests
 
         configured_component_path = component_path
         if configured_component_path.start_with?("app#{File::SEPARATOR}")

lib/view_component.rb

@@ -13,6 +13,7 @@ module ViewComponent
   autoload :ComponentError
   autoload :Config
   autoload :Deprecation
+  autoload :GlobalConfig
   autoload :InlineTemplate
   autoload :Instrumentation
   autoload :Preview

lib/view_component/base.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "action_view"
-require "active_support/configurable"
 require "view_component/collection"
 require "view_component/compile_cache"
 require "view_component/compiler"
@@ -38,16 +37,15 @@ def config
     RESERVED_PARAMETER = :content
     VC_INTERNAL_DEFAULT_FORMAT = :html
 
-    # For CSRF authenticity tokens in forms
-    delegate :form_authenticity_token, :protect_against_forgery?, :config, to: :helpers
-
-    # For Content Security Policy nonces
-    delegate :content_security_policy_nonce, to: :helpers
+    # For CSRF authenticity tokens in forms and Content Security Policy nonces
+    use_helpers :form_authenticity_token, :protect_against_forgery?, :config, :content_security_policy_nonce
 
     # Config option that strips trailing whitespace in templates before compiling them.
     class_attribute :__vc_strip_trailing_whitespace, instance_accessor: false, instance_predicate: false
     self.__vc_strip_trailing_whitespace = false # class_attribute:default doesn't work until Rails 5.2
 
+    delegate :component_config, to: :class
+
     attr_accessor :__vc_original_view_context
 
     # Components render in their own view context. Helpers and other functionality
@@ -234,7 +232,7 @@ def controller
     # @return [ActionView::Base]
     def helpers
       raise HelpersCalledBeforeRenderError if view_context.nil?
-
+      raise StrictHelperError unless GlobalConfig.helpers_enabled
       # Attempt to re-use the original view_context passed to the first
       # component rendered in the rendering pipeline. This prevents the
       # instantiation of a new view_context via `controller.view_context` which
@@ -251,11 +249,19 @@ def method_missing(method_name, *args) # rubocop:disable Style/MissingRespondToM
         super
       rescue => e # rubocop:disable Style/RescueStandardError
         e.set_backtrace e.backtrace.tap(&:shift)
-        raise e, <<~MESSAGE.chomp if view_context && e.is_a?(NameError) && helpers.respond_to?(method_name)
-          #{e.message}
-
-          You may be trying to call a method provided as a view helper. Did you mean `helpers.#{method_name}'?
-        MESSAGE
+        if !GlobalConfig.helpers_enabled
+          raise e, <<~MESSAGE.chomp if view_context && e.is_a?(NameError) && (__vc_original_view_context.respond_to?(method_name) || controller.view_context.respond_to?(method_name))
+            #{e.message}
+
+              You may be trying to call a method provided as a view helper. To use it try decalring it using use_helpers :#{method_name}'?
+          MESSAGE
+        elsif view_context && e.is_a?(NameError) && helpers.respond_to?(method_name)
+          raise e, <<~MESSAGE.chomp
+            #{e.message}
+
+            You may be trying to call a method provided as a view helper. Did you mean `helpers.#{method_name}'?
+          MESSAGE
+        end
 
         raise
       end
@@ -468,6 +474,7 @@ def sidecar_files(extensions)
         # view files in a directory named like the component
         directory = File.dirname(source_location)
         filename = File.basename(source_location, ".rb")
+        return [] if name.blank?
         component_name = name.demodulize.underscore
 
         # Add support for nested components defined in the same file.
@@ -513,6 +520,16 @@ def inherited(child)
         # `compile` defines
         compile
 
+        if child.superclass == ViewComponent::Base
+          child.define_singleton_method(:component_config) do
+            @@component_config ||= Rails.application.config.view_component.inheritable_copy
+          end
+        else
+          child.define_singleton_method(:component_config) do
+            @@component_config ||= superclass.component_config.inheritable_copy
+          end
+        end
+
         # Give the child its own personal #render_template_for to protect against the case when
         # eager loading is disabled and the parent component is rendered before the child. In
         # such a scenario, the parent will override ViewComponent::Base#render_template_for,
@@ -545,7 +562,7 @@ def render_template_for(variant = nil, format = nil)
         # If Rails application is loaded, removes the first part of the path and the extension.
         if defined?(Rails) && Rails.application
           child.virtual_path = child.source_location.gsub(
-            /(.*#{Regexp.quote(ViewComponent::Base.config.view_component_path)})|(\.rb)/, ""
+            /(.*#{Regexp.quote(GlobalConfig.view_component_path)})|(\.rb)/, ""
           )
         end
 

lib/view_component/config.rb

@@ -11,7 +11,7 @@ class << self
       alias_method :default, :new
 
       def defaults
-        ActiveSupport::OrderedOptions.new.merge!({
+        ActiveSupport::InheritableOptions.new({
           generate: default_generate_options,
           preview_controller: "ViewComponentsController",
           preview_route: "/rails/view_components",
@@ -25,7 +25,9 @@ def defaults
           preview_paths: default_preview_paths,
           test_controller: "ApplicationController",
           default_preview_layout: nil,
-          capture_compatibility_patch_enabled: false
+          capture_compatibility_patch_enabled: false,
+          helpers_enabled: true,
+          strict_helpers_enabled?: false
         })
       end
 
@@ -173,6 +175,11 @@ def defaults
       # previews.
       # Defaults to `false`.
 
+      # @!attribute helpers_enabled
+      # @return [Boolean]
+      # Enables the use of #helpers
+      # Defaults to `True`.
+
       def default_preview_paths
         (default_rails_preview_paths + default_rails_engines_preview_paths).uniq
       end

lib/view_component/engine.rb

@@ -6,7 +6,7 @@
 
 module ViewComponent
   class Engine < Rails::Engine # :nodoc:
-    config.view_component = ViewComponent::Config.current
+    config.view_component = ViewComponent::Config.defaults
 
     if Rails.version.to_f < 8.0
       rake_tasks do
@@ -15,15 +15,15 @@ class Engine < Rails::Engine # :nodoc:
     else
       initializer "view_component.stats_directories" do |app|
         require "rails/code_statistics"
-        dir = ViewComponent::Base.view_component_path
+        dir = GlobalConfig.view_component_path
         Rails::CodeStatistics.register_directory("ViewComponents", dir)
       end
     end
 
     initializer "view_component.set_configs" do |app|
       options = app.config.view_component
 
-      %i[generate preview_controller preview_route show_previews_source].each do |config_option|
+      %i[generate preview_controller preview_route].each do |config_option|
         options[config_option] ||= ViewComponent::Base.public_send(config_option)
       end
       options.instrumentation_enabled = false if options.instrumentation_enabled.nil?

lib/view_component/errors.rb

@@ -234,6 +234,10 @@ class SystemTestControllerNefariousPathError < BaseError
     MESSAGE = "ViewComponent SystemTest controller attempted to load a file outside of the expected directory."
   end
 
+  class StrictHelperError < BaseError
+    MESSAGE = "ViewComponent strict helper mode is enbaled so #helpers is disabled."
+  end
+
   class AlreadyDefinedPolymorphicSlotSetterError < StandardError
     MESSAGE =
       "A method called 'SETTER_METHOD_NAME' already exists and would be overwritten by the 'SETTER_NAME' polymorphic " \

lib/view_component/global_config.rb

@@ -0,0 +1,3 @@
+module ViewComponent
+  GlobalConfig = (defined?(Rails) && Rails.application) ? Rails.application.config.view_component : Base.config # standard:disable Naming/ConstantName
+end

lib/view_component/instrumentation.rb

@@ -23,7 +23,7 @@ def render_in(view_context, &block)
     private
 
     def notification_name
-      return "!render.view_component" if ViewComponent::Base.config.use_deprecated_instrumentation_name
+      return "!render.view_component" if GlobalConfig.use_deprecated_instrumentation_name
 
       "render.view_component"
     end

lib/view_component/preview.rb

@@ -109,7 +109,7 @@ def load_previews
       private
 
       def preview_paths
-        Base.preview_paths
+        ViewComponent::GlobalConfig.preview_paths
       end
     end
   end

lib/view_component/rails/tasks/view_component.rake

@@ -7,7 +7,7 @@ namespace :view_component do
     # :nocov:
     require "rails/code_statistics"
 
-    dir = ViewComponent::Base.view_component_path
+    dir = ViewComponent::GlobalConfig.view_component_path
     ::STATS_DIRECTORIES << ["ViewComponents", dir] if File.directory?(Rails.root + dir)
     # :nocov:
   end

lib/view_component/test_helpers.rb

@@ -250,7 +250,8 @@ def with_request_url(full_path, host: nil, method: nil, format: ViewComponent::B
     #
     # @return [ActionController::Base]
     def vc_test_controller
-      @vc_test_controller ||= __vc_test_helpers_build_controller(Base.test_controller.constantize)
+      config_source = defined?(Rails) ? Rails.application.config.view_component : ViewComponent::Base
+      @vc_test_controller ||= __vc_test_helpers_build_controller(config_source.test_controller.constantize)
     end
 
     # Access the request used by `render_inline`: