Hello InlineSlimComponent!
+Hello World!
+ ## Sibling file Place template file next to the component: diff --git a/docs/index.md b/docs/index.md index 2e029402e..a54f26bf8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -209,6 +209,7 @@ ViewComponent is built by over a hundred members of the community, including:
+
## Who uses ViewComponent?
@@ -243,12 +244,15 @@ ViewComponent is built by over a hundred members of the community, including:
* [openSUSE Open Build Service](https://openbuildservice.org/)
* [Ophelos](https://ophelos.com)
* [Orbit](https://orbit.love)
+* [PeopleForce](https://peopleforce.io)
* [PLT4M](https://plt4m.com/)
* [Podia](https://www.podia.com/)
* [PrintReleaf](https://www.printreleaf.com/)
* [Project Blacklight](http://projectblacklight.org/)
* [QuickNode](https://www.quicknode.com/)
* [Room AI](https://roomai.com/)
+* [SearchApi](https://www.searchapi.io/)
+* [Simundia](https://www.simundia.com/)
* [Skroutz](https://engineering.skroutz.gr/blog/)
* [Shogun](https://getshogun.com/)
* [Spina CMS](https://spinacms.com/)
diff --git a/docs/known_issues.md b/docs/known_issues.md
index ae27f2d34..ce20d6abf 100644
--- a/docs/known_issues.md
+++ b/docs/known_issues.md
@@ -6,7 +6,23 @@ nav_order: 9
# Known issues
-## turbo_frame_tag double rendering or scrambled HTML structure
+## Issues resolved by the optional capture compatibility patch
+
+If you're experiencing issues with duplicated content or malformed HTML output, the capture compatibility patch may resolve these.
+
+[Set `config.view_component.capture_compatibility_patch_enabled` to `true`](https://viewcomponent.org/api.html#capture_compatibility_patch_enabled) to resolve these issues.
+
+These issues arise because the related features/methods keep a reference to the
+primary `ActionView::Base` instance, which has its own `@output_buffer`. When
+`#capture` is called on the original `ActionView::Base` instance while
+evaluating a block from a ViewComponent, the `@output_buffer` is overridden in
+the `ActionView::Base` instance, and *not* the component. This results in a
+double render due to `#capture` implementation details.
+
+To resolve the issue, we override `#capture` so that we can delegate the
+`capture` logic to the ViewComponent that created the block.
+
+### turbo_frame_tag double rendering or scrambled HTML structure
When using `turbo_frame_tag` inside a ViewComponent, the template may be rendered twice. See [https://github.com/github/view_component/issues/1099](https://github.com/github/view_component/issues/1099).
@@ -14,7 +30,7 @@ As a workaround, use `tag.turbo_frame` instead of `turbo_frame_tag`.
Note: For the same functionality as `turbo_frame_tag(my_model)`, use `tag.turbo_frame(id: dom_id(my_model))`.
-## Compatibility with Rails form helpers
+### Compatibility with Rails form helpers
ViewComponent [isn't compatible](https://github.com/viewcomponent/view_component/issues/241) with `form_for` helpers by default.
diff --git a/lib/view_component/base.rb b/lib/view_component/base.rb
index 9efc78738..0bdee95af 100644
--- a/lib/view_component/base.rb
+++ b/lib/view_component/base.rb
@@ -22,12 +22,8 @@ class << self
#
# @return [ActiveSupport::OrderedOptions]
def config
- @config ||= ActiveSupport::OrderedOptions.new
+ ViewComponent::Config.current
end
-
- # Replaces the entire config. You shouldn't need to use this directly
- # unless you're building a `ViewComponent::Config` elsewhere.
- attr_writer :config
end
include ViewComponent::InlineTemplate
@@ -223,6 +219,21 @@ def helpers
@__vc_helpers ||= __vc_original_view_context || controller.view_context
end
+ if Rails.env.development? || Rails.env.test?
+ def method_missing(method_name, *args) # rubocop:disable Style/MissingRespondToMissing
+ 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
+
+ raise
+ end
+ end
+
# Exposes .virtual_path as an instance method
#
# @private
@@ -542,6 +553,7 @@ def identifier
# @param parameter [Symbol] The parameter name used when rendering elements of a collection.
def with_collection_parameter(parameter)
@provided_collection_parameter = parameter
+ @initialize_parameters = nil
end
# Strips trailing whitespace from templates before compiling them.
@@ -637,7 +649,7 @@ def initialize_parameter_names
end
def initialize_parameters
- instance_method(:initialize).parameters
+ @initialize_parameters ||= instance_method(:initialize).parameters
end
def provided_collection_parameter
diff --git a/lib/view_component/config.rb b/lib/view_component/config.rb
index ce444dca4..8ad6e1571 100644
--- a/lib/view_component/config.rb
+++ b/lib/view_component/config.rb
@@ -167,6 +167,14 @@ def default_generate_options
end
end
+ # @!attribute current
+ # @return [ViewComponent::Config]
+ # Returns the current ViewComponent::Config. This is persisted against this
+ # class so that config options remain accessible before the rest of
+ # ViewComponent has loaded. Defaults to an instance of ViewComponent::Config
+ # with all other documented defaults set.
+ class_attribute :current, default: defaults, instance_predicate: false
+
def initialize
@config = self.class.defaults
end
diff --git a/lib/view_component/engine.rb b/lib/view_component/engine.rb
index 4569678fb..7c3740bce 100644
--- a/lib/view_component/engine.rb
+++ b/lib/view_component/engine.rb
@@ -6,7 +6,7 @@
module ViewComponent
class Engine < Rails::Engine # :nodoc:
- config.view_component = ViewComponent::Config.defaults
+ config.view_component = ViewComponent::Config.current
rake_tasks do
load "view_component/rails/tasks/view_component.rake"
@@ -15,6 +15,9 @@ class Engine < Rails::Engine # :nodoc:
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|
+ options[config_option] ||= ViewComponent::Base.public_send(config_option)
+ end
options.instrumentation_enabled = false if options.instrumentation_enabled.nil?
options.render_monkey_patch_enabled = true if options.render_monkey_patch_enabled.nil?
options.show_previews = (Rails.env.development? || Rails.env.test?) if options.show_previews.nil?
@@ -37,8 +40,6 @@ class Engine < Rails::Engine # :nodoc:
initializer "view_component.enable_instrumentation" do |app|
ActiveSupport.on_load(:view_component) do
- Base.config = app.config.view_component
-
if app.config.view_component.instrumentation_enabled.present?
# :nocov: Re-executing the below in tests duplicates initializers and causes order-dependent failures.
ViewComponent::Base.prepend(ViewComponent::Instrumentation)
diff --git a/lib/view_component/test_helpers.rb b/lib/view_component/test_helpers.rb
index cbea3301a..1cb733451 100644
--- a/lib/view_component/test_helpers.rb
+++ b/lib/view_component/test_helpers.rb
@@ -177,7 +177,8 @@ def with_request_url(path, host: nil)
vc_test_request.host = host if host
vc_test_request.path_info = path
vc_test_request.path_parameters = Rails.application.routes.recognize_path_with_request(vc_test_request, path, {})
- vc_test_request.set_header("action_dispatch.request.query_parameters", Rack::Utils.parse_nested_query(query))
+ vc_test_request.set_header("action_dispatch.request.query_parameters",
+ Rack::Utils.parse_nested_query(query).with_indifferent_access)
vc_test_request.set_header(Rack::QUERY_STRING, query)
yield
ensure
diff --git a/lib/view_component/version.rb b/lib/view_component/version.rb
index cc0c9e583..792015941 100644
--- a/lib/view_component/version.rb
+++ b/lib/view_component/version.rb
@@ -3,7 +3,7 @@
module ViewComponent
module VERSION
MAJOR = 3
- MINOR = 5
+ MINOR = 6
PATCH = 0
PRE = nil
diff --git a/test/sandbox/app/components/references_method_on_helpers_component.html.erb b/test/sandbox/app/components/references_method_on_helpers_component.html.erb
new file mode 100644
index 000000000..9899d3040
--- /dev/null
+++ b/test/sandbox/app/components/references_method_on_helpers_component.html.erb
@@ -0,0 +1 @@
+<%= current_user %>
diff --git a/test/sandbox/app/components/references_method_on_helpers_component.rb b/test/sandbox/app/components/references_method_on_helpers_component.rb
new file mode 100644
index 000000000..4be21aa47
--- /dev/null
+++ b/test/sandbox/app/components/references_method_on_helpers_component.rb
@@ -0,0 +1,4 @@
+# frozen_string_literal: true
+
+class ReferencesMethodOnHelpersComponent < ViewComponent::Base
+end
diff --git a/test/sandbox/test/base_test.rb b/test/sandbox/test/base_test.rb
index 4b746be73..f117dc270 100644
--- a/test/sandbox/test/base_test.rb
+++ b/test/sandbox/test/base_test.rb
@@ -106,4 +106,35 @@ def initialize(cta: nil, title:)
eval(source) # rubocop:disable Security/Eval
end
+
+ def test_no_method_error_does_not_reference_helper_if_view_context_not_present
+ exception = assert_raises(NoMethodError) { Class.new(ViewComponent::Base).new.current_user }
+ exception_message_regex = Regexp.new <<~MESSAGE.chomp, Regexp::MULTILINE
+ undefined method `current_user' for .*
+
+ You may be trying to call a method provided as a view helper. Did you mean `helpers.current_user'?
+ MESSAGE
+ assert !exception_message_regex.match?(exception.message)
+ end
+
+ def test_no_method_error_references_helper_if_view_context_present
+ view_context = ActionController::Base.new.view_context
+ view_context.instance_eval {
+ def current_user
+ "a user"
+ end
+ }
+ exception = assert_raises(NameError) { ReferencesMethodOnHelpersComponent.new.render_in(view_context) }
+ exception_advice = "You may be trying to call a method provided as a view helper. Did you mean `helpers.current_user'?"
+ assert exception.message.include?(exception_advice)
+ end
+
+ def test_no_method_error_does_not_reference_missing_helper
+ view_context = ActionController::Base.new.view_context
+ exception = assert_raises(NameError) { ReferencesMethodOnHelpersComponent.new.render_in(view_context) }
+ exception_message_regex = Regexp.new <<~MESSAGE.chomp
+ You may be trying to call a method provided as a view helper\\. Did you mean `helpers.current_user'\\?$
+ MESSAGE
+ assert !exception_message_regex.match?(exception.message)
+ end
end
diff --git a/test/sandbox/test/config_test.rb b/test/sandbox/test/config_test.rb
index 9c741ed12..b74d02fd9 100644
--- a/test/sandbox/test/config_test.rb
+++ b/test/sandbox/test/config_test.rb
@@ -34,7 +34,7 @@ def test_all_methods_are_documented
end
options_defined_on_instance = Set[*default_options, *accessors]
assert options_defined_on_instance.subset?(Set[*configuration_methods_to_document.map(&:name)]),
- "Not all configuration options are documented: #{configuration_methods_to_document.map(&:name) - options_defined_on_instance.to_a}"
+ "Not all configuration options are documented: #{options_defined_on_instance.to_a - configuration_methods_to_document.map(&:name)}"
assert configuration_methods_to_document.map(&:docstring).all?(&:present?),
"Configuration options are missing docstrings."
end
diff --git a/test/sandbox/test/generators/preview_generator_test.rb b/test/sandbox/test/generators/preview_generator_test.rb
index 361c01ac0..436e6e86c 100644
--- a/test/sandbox/test/generators/preview_generator_test.rb
+++ b/test/sandbox/test/generators/preview_generator_test.rb
@@ -3,6 +3,9 @@
require "test_helper"
require "rails/generators/preview/component_generator"
+# See: https://github.com/rails/rails/pull/47752#issuecomment-1720256371
+require "active_record"
+
Rails.application.load_generators
class PreviewGeneratorTest < Rails::Generators::TestCase
diff --git a/test/sandbox/test/rendering_test.rb b/test/sandbox/test/rendering_test.rb
index f9bac0557..2f5069ea4 100644
--- a/test/sandbox/test/rendering_test.rb
+++ b/test/sandbox/test/rendering_test.rb
@@ -855,6 +855,7 @@ def test_with_request_url_with_query_parameters
assert_equal "/products", vc_test_request.path
assert_equal "mykey=myvalue&otherkey=othervalue", vc_test_request.query_string
assert_equal "/products?mykey=myvalue&otherkey=othervalue", vc_test_request.fullpath
+ assert_instance_of ActiveSupport::HashWithIndifferentAccess, vc_test_request.query_parameters
end
with_request_url "/products?mykey[mynestedkey]=myvalue" do
diff --git a/test/sandbox/test/translatable_test.rb b/test/sandbox/test/translatable_test.rb
index fd2f49b6b..fea351318 100644
--- a/test/sandbox/test/translatable_test.rb
+++ b/test/sandbox/test/translatable_test.rb
@@ -79,10 +79,11 @@ def test_translate_uses_the_helper_when_no_sidecar_file_is_provided
# The cache needs to be kept clean for TranslatableComponent, otherwise it will rely on the
# already created i18n_backend.
ViewComponent::CompileCache.invalidate_class!(TranslatableComponent)
+ original_method = TranslatableComponent.method(:sidecar_files)
ViewComponent::Base.stub(
:sidecar_files,
- ->(exts) { exts.include?("yml") ? [] : TranslatableComponent.__minitest_stub___sidecar_files(exts) }
+ ->(exts) { exts.include?("yml") ? [] : original_method.call(exts) }
) do
assert_equal "MISSING", translate(".hello", default: "MISSING")
assert_equal "Hello from Rails translations!", translate("hello")
diff --git a/test/sandbox/test/view_component_system_test.rb b/test/sandbox/test/view_component_system_test.rb
index 086f54b12..067c345fe 100644
--- a/test/sandbox/test/view_component_system_test.rb
+++ b/test/sandbox/test/view_component_system_test.rb
@@ -3,7 +3,7 @@
require "test_helper"
class ViewComponentSystemTest < ViewComponent::SystemTestCase
- driven_by :cuprite
+ driven_by :vc_cuprite
def test_simple_js_interaction_in_browser_without_layout
with_rendered_component_path(render_inline(SimpleJavascriptInteractionWithJsIncludedComponent.new)) do |path|
diff --git a/test/test_helper.rb b/test/test_helper.rb
index 6528bdb12..aa7a61584 100644
--- a/test/test_helper.rb
+++ b/test/test_helper.rb
@@ -40,7 +40,9 @@ def self.warn(message)
require "capybara/cuprite"
-Capybara.register_driver(:cuprite) do |app|
+# Rails registers its own driver named "cuprite" which will overwrite the one we
+# register here. Avoid the problem by registering the driver with a distinct name.
+Capybara.register_driver(:vc_cuprite) do |app|
# Add the process_timeout option to prevent failures due to the browser
# taking too long to start up.
Capybara::Cuprite::Driver.new(app, {process_timeout: 60, timeout: 30})