Merge branch 'v4' into 2188-config

Author: joelhawksley

app/controllers/concerns/view_component/preview_actions.rb

@@ -8,7 +8,7 @@ module PreviewActions
       prepend_view_path File.expand_path("../../../views", __dir__)
 
       around_action :set_locale, only: :previews
-      before_action :require_local!, unless: :show_previews?
+      before_action :require_local!, unless: :previews_enabled?
 
       content_security_policy(false)
 
@@ -51,8 +51,8 @@ def default_preview_layout
     end
 
     # :doc:
-    def show_previews?
-      ViewComponent::Base.config.show_previews
+    def previews_enabled?
+      ViewComponent::Base.config.previews.enabled
     end
 
     # :doc:

docs/CHANGELOG.md

@@ -22,6 +22,10 @@ nav_order: 6
 
     *Joel Hawksley*
 
+* Fix bug where `config.previews.enabled` did not function properly in production environments.
+
+    *Joel Hawksley*
+
 * `config.previews.default_layout` should default to nil.
 
     *Joel Hawksley*

docs/guide/helpers.md

@@ -62,3 +62,9 @@ edit_user_path # implicitly depends on current request to provide `user`
 # good
 edit_user_path(user: current_user)
 ```
+
+Alternatively, use the `helpers` proxy:
+
+```ruby
+helpers.edit_user_path
+```

docs/guide/previews.md

@@ -201,11 +201,11 @@ end
 
 ## Enabling previews
 
-Previews are enabled by default in test and development environments. To enable or disable previews, use the `show_previews` option:
+Previews are enabled by default in test and development environments. To enable or disable previews, use the `previews.enabled` option:
 
 ```ruby
 # config/environments/test.rb
-config.view_component.show_previews = false
+config.view_component.previews.enabled = false
 ```
 
 ## Use with RSpec

lib/view_component/engine.rb

@@ -15,9 +15,9 @@ class Engine < Rails::Engine # :nodoc:
         options[config_option] ||= ViewComponent::Base.public_send(config_option)
       end
       options.instrumentation_enabled = false if options.instrumentation_enabled.nil?
-      options.show_previews = (Rails.env.development? || Rails.env.test?) if options.show_previews.nil?
+      options.previews.enabled = (Rails.env.development? || Rails.env.test?) if options.previews.enabled.nil?
 
-      if options.show_previews
+      if options.previews.enabled
         # This is still necessary because when `config.view_component` is declared, `Rails.root` is unspecified.
         options.previews.paths << "#{Rails.root}/test/components/previews" if defined?(Rails.root) && Dir.exist?(
           "#{Rails.root}/test/components/previews"
@@ -36,7 +36,7 @@ class Engine < Rails::Engine # :nodoc:
     initializer "view_component.set_autoload_paths" do |app|
       options = app.config.view_component
 
-      if options.show_previews && !options.previews.paths.empty?
+      if options.previews.enabled && !options.previews.paths.empty?
         paths_to_add = options.previews.paths - ActiveSupport::Dependencies.autoload_paths
         ActiveSupport::Dependencies.autoload_paths.concat(paths_to_add) if paths_to_add.any?
       end
@@ -88,7 +88,7 @@ class Engine < Rails::Engine # :nodoc:
     config.after_initialize do |app|
       options = app.config.view_component
 
-      if options.show_previews
+      if options.previews.enabled
         app.routes.prepend do
           preview_controller = options.previews.controller.sub(/Controller$/, "").underscore
 

test/sandbox/config/application.rb

@@ -44,7 +44,7 @@ class Application < Rails::Application
     config.view_component.previews.paths << "#{config.root}/my/components/previews"
     config.view_component.previews.paths << "#{Rails.root}/lib/component_previews"
 
-    config.action_mailer.default_url_options = { :host => "www.yourhost.com" }
+    config.action_mailer.default_url_options = {host: "www.yourhost.com"}
   end
 end
 

test/sandbox/config/environments/test.rb

@@ -28,7 +28,6 @@
   # Disable request forgery protection in test environment
   config.action_controller.allow_forgery_protection = false
 
-  config.view_component.show_previews = true
   config.view_component.instrumentation_enabled = true
 
   # Tell Action Mailer not to deliver emails to the real world.

test/sandbox/test/integration_test.rb

@@ -285,6 +285,14 @@ def test_optional_rendering_component_depending_on_request_context
     refute_includes response.body, "Rendered"
   end
 
+  def test_previews_can_be_disabled
+    with_previews_option(:enabled, false) do
+      get "/rails/view_components/my_component/default"
+
+      assert_response 200
+    end
+  end
+
   def test_renders_component_preview
     get "/rails/view_components/my_component/default"