Merge branch 'main' into component-local-config

Author: joelhawksley

docs/CHANGELOG.md

@@ -14,6 +14,10 @@ nav_order: 5
 
     *Simon Fish*
 
+* Add unused mechanism for inheriting config from parent modules to enable future engine-local configuration.
+
+    *Simon Fish*
+
 * Improve handling of malformed component edge case when mocking components in tests.
 
     *Martin Meyerhoff*, *Joel Hawksley*

lib/view_component/base.rb

@@ -26,6 +26,10 @@ class << self
       #
       # @return [ActiveSupport::OrderedOptions]
       def config
+        module_parents.each do |m|
+          config = m.try(:config).try(:view_component)
+          return config if config
+        end
         ViewComponent::Config.current
       end
     end

lib/view_component/configurable.rb

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+module ViewComponent
+  module Configurable
+    extend ActiveSupport::Concern
+
+    included do
+      next if respond_to?(:config) && config.respond_to?(:view_component) && config.respond_to_missing?(:test_controller)
+
+      include ActiveSupport::Configurable
+
+      configure do |config|
+        config.view_component ||= ActiveSupport::InheritableOptions.new
+      end
+    end
+  end
+end

test/sandbox/test/base_test.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "test_helper"
+require "view_component/configurable"
 
 class ViewComponent::Base::UnitTest < Minitest::Test
   def test_identifier
@@ -154,4 +155,54 @@ def test_component_local_config_is_inheritable
     # This component overrides the defaults.
     assert_equal true, ConfigurableComponent.configuration.strip_trailing_whitespace
   end
+
+  module TestModuleWithoutConfig
+    class SomeComponent < ViewComponent::Base
+    end
+  end
+
+  # Config defined on top-level module as opposed to engine.
+  module TestModuleWithConfig
+    include ViewComponent::Configurable
+
+    configure do |config|
+      config.view_component.test_controller = "AnotherController"
+    end
+
+    class SomeComponent < ViewComponent::Base
+    end
+  end
+
+  module TestAlreadyConfigurableModule
+    include ActiveSupport::Configurable
+    include ViewComponent::Configurable
+
+    configure do |config|
+      config.view_component.test_controller = "AnotherController"
+    end
+
+    class SomeComponent < ViewComponent::Base
+    end
+  end
+
+  module TestAlreadyConfiguredModule
+    include ActiveSupport::Configurable
+
+    configure do |config|
+      config.view_component = ActiveSupport::InheritableOptions[test_controller: "AnotherController"]
+    end
+
+    include ViewComponent::Configurable
+
+    class SomeComponent < ViewComponent::Base
+    end
+  end
+
+  def test_uses_module_configuration
+    # We override this ourselves in test/sandbox/config/environments/test.rb.
+    assert_equal "IntegrationExamplesController", TestModuleWithoutConfig::SomeComponent.test_controller
+    assert_equal "AnotherController", TestModuleWithConfig::SomeComponent.test_controller
+    assert_equal "AnotherController", TestAlreadyConfigurableModule::SomeComponent.test_controller
+    assert_equal "AnotherController", TestAlreadyConfiguredModule::SomeComponent.test_controller
+  end
 end

test/sandbox/test/rendering_test.rb

@@ -16,8 +16,8 @@ def test_render_inline_allocations
     MyComponent.ensure_compiled
 
     allocations = (Rails.version.to_f >= 8.0) ?
-      {"3.5.0" => 115, "3.4.2" => 117, "3.3.7" => 129} :
-      {"3.3.7" => 120, "3.3.0" => 132, "3.2.7" => 118, "3.1.6" => 118, "3.0.7" => 127}
+      {"3.5.0" => 123, "3.4.2" => 125, "3.3.7" => 137} :
+      {"3.3.7" => 128, "3.3.0" => 140, "3.2.7" => 126, "3.1.6" => 126, "3.0.7" => 135}
 
     assert_allocations(**allocations) do
       render_inline(MyComponent.new)