@@ -14,4 +14,4 @@
<% end %>
+
@@ -211,6 +212,7 @@ ViewComponent is built by over a hundred members of the community, including:
+
## Who uses ViewComponent?
diff --git a/lib/view_component/base.rb b/lib/view_component/base.rb
index 1b5d74c601..fc33619e6d 100644
--- a/lib/view_component/base.rb
+++ b/lib/view_component/base.rb
@@ -12,6 +12,7 @@
require "view_component/slotable"
require "view_component/translatable"
require "view_component/with_content_helper"
+require "view_component/use_helpers"
module ViewComponent
class Base < ActionView::Base
@@ -219,7 +220,7 @@ def helpers
@__vc_helpers ||= __vc_original_view_context || controller.view_context
end
- if Rails.env.development? || Rails.env.test?
+ if ::Rails.env.development? || ::Rails.env.test?
def method_missing(method_name, *args) # rubocop:disable Style/MissingRespondToMissing
super
rescue => e # rubocop:disable Style/RescueStandardError
diff --git a/lib/view_component/compiler.rb b/lib/view_component/compiler.rb
index 23d9b2ce04..1cc258dffc 100644
--- a/lib/view_component/compiler.rb
+++ b/lib/view_component/compiler.rb
@@ -229,12 +229,12 @@ def inline_calls
component_class.included_modules
)
- view_component_ancestors.flat_map { |ancestor| ancestor.instance_methods(false).grep(/^call/) }.uniq
+ view_component_ancestors.flat_map { |ancestor| ancestor.instance_methods(false).grep(/^call(_|$)/) }.uniq
end
end
def inline_calls_defined_on_self
- @inline_calls_defined_on_self ||= component_class.instance_methods(false).grep(/^call/)
+ @inline_calls_defined_on_self ||= component_class.instance_methods(false).grep(/^call(_|$)/)
end
def variants
diff --git a/lib/view_component/engine.rb b/lib/view_component/engine.rb
index f2943ae719..7d33ec5cce 100644
--- a/lib/view_component/engine.rb
+++ b/lib/view_component/engine.rb
@@ -113,11 +113,15 @@ class Engine < Rails::Engine # :nodoc:
end
initializer "static assets" do |app|
- if app.config.view_component.show_previews
+ if serve_static_preview_assets?(app.config)
app.middleware.use(::ActionDispatch::Static, "#{root}/app/assets/vendor")
end
end
+ def serve_static_preview_assets?(app_config)
+ app_config.view_component.show_previews && app_config.public_file_server.enabled
+ end
+
initializer "compiler mode" do |_app|
ViewComponent::Compiler.mode = if Rails.env.development? || Rails.env.test?
ViewComponent::Compiler::DEVELOPMENT_MODE
diff --git a/lib/view_component/errors.rb b/lib/view_component/errors.rb
index 36f9ee570c..b896f53d1c 100644
--- a/lib/view_component/errors.rb
+++ b/lib/view_component/errors.rb
@@ -104,7 +104,10 @@ class InvalidSlotDefinitionError < BaseError
"string, or callable (that is proc, lambda, etc)"
end
- class SlotPredicateNameError < StandardError
+ class InvalidSlotNameError < StandardError
+ end
+
+ class SlotPredicateNameError < InvalidSlotNameError
MESSAGE =
"COMPONENT declares a slot named SLOT_NAME, which ends with a question mark.\n\n" \
"This isn't allowed because the ViewComponent framework already provides predicate " \
@@ -126,7 +129,7 @@ def initialize(klass_name, slot_name)
end
end
- class ReservedSingularSlotNameError < StandardError
+ class ReservedSingularSlotNameError < InvalidSlotNameError
MESSAGE =
"COMPONENT declares a slot named SLOT_NAME, which is a reserved word in the ViewComponent framework.\n\n" \
"To fix this issue, choose a different name."
@@ -136,7 +139,7 @@ def initialize(klass_name, slot_name)
end
end
- class ReservedPluralSlotNameError < StandardError
+ class ReservedPluralSlotNameError < InvalidSlotNameError
MESSAGE =
"COMPONENT declares a slot named SLOT_NAME, which is a reserved word in the ViewComponent framework.\n\n" \
"To fix this issue, choose a different name."
diff --git a/lib/view_component/slotable.rb b/lib/view_component/slotable.rb
index ecb4826a20..b38ab3100f 100644
--- a/lib/view_component/slotable.rb
+++ b/lib/view_component/slotable.rb
@@ -295,6 +295,7 @@ def validate_plural_slot_name(slot_name)
raise ReservedPluralSlotNameError.new(name, slot_name)
end
+ raise_if_slot_conflicts_with_call(slot_name)
raise_if_slot_ends_with_question_mark(slot_name)
raise_if_slot_registered(slot_name)
end
@@ -308,6 +309,7 @@ def validate_singular_slot_name(slot_name)
raise ReservedSingularSlotNameError.new(name, slot_name)
end
+ raise_if_slot_conflicts_with_call(slot_name)
raise_if_slot_ends_with_question_mark(slot_name)
raise_if_slot_registered(slot_name)
end
@@ -320,7 +322,13 @@ def raise_if_slot_registered(slot_name)
end
def raise_if_slot_ends_with_question_mark(slot_name)
- raise SlotPredicateNameError.new(name, slot_name) if slot_name.to_s.ends_with?("?")
+ raise SlotPredicateNameError.new(name, slot_name) if slot_name.to_s.end_with?("?")
+ end
+
+ def raise_if_slot_conflicts_with_call(slot_name)
+ if slot_name.start_with?("call_")
+ raise InvalidSlotNameError, "Slot cannot start with 'call_'. Please rename #{slot_name}"
+ end
end
end
diff --git a/lib/view_component/test_helpers.rb b/lib/view_component/test_helpers.rb
index 3a24b1aa31..02d1a9b7c4 100644
--- a/lib/view_component/test_helpers.rb
+++ b/lib/view_component/test_helpers.rb
@@ -163,10 +163,20 @@ def with_controller_class(klass)
# end
# ```
#
+ # To specify a request method, pass the method param:
+ #
+ # ```ruby
+ # with_request_url("/users/42", method: "POST") do
+ # render_inline(MyComponent.new)
+ # end
+ # ```
+ #
# @param path [String] The path to set for the current request.
# @param host [String] The host to set for the current request.
- def with_request_url(full_path, host: nil)
+ # @param method [String] The request method to set for the current request.
+ def with_request_url(full_path, host: nil, method: nil)
old_request_host = vc_test_request.host
+ old_request_method = vc_test_request.request_method
old_request_path_info = vc_test_request.path_info
old_request_path_parameters = vc_test_request.path_parameters
old_request_query_parameters = vc_test_request.query_parameters
@@ -177,6 +187,7 @@ def with_request_url(full_path, host: nil)
vc_test_request.instance_variable_set(:@fullpath, full_path)
vc_test_request.instance_variable_set(:@original_fullpath, full_path)
vc_test_request.host = host if host
+ vc_test_request.request_method = method if method
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",
@@ -185,6 +196,7 @@ def with_request_url(full_path, host: nil)
yield
ensure
vc_test_request.host = old_request_host
+ vc_test_request.request_method = old_request_method
vc_test_request.path_info = old_request_path_info
vc_test_request.path_parameters = old_request_path_parameters
vc_test_request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)
diff --git a/lib/view_component/use_helpers.rb b/lib/view_component/use_helpers.rb
new file mode 100644
index 0000000000..32d13cd433
--- /dev/null
+++ b/lib/view_component/use_helpers.rb
@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module ViewComponent::UseHelpers
+ extend ActiveSupport::Concern
+
+ class_methods do
+ def use_helpers(*args)
+ args.each do |helper_method|
+ class_eval(<<-RUBY, __FILE__, __LINE__ + 1)
+ def #{helper_method}(*args, &block)
+ raise HelpersCalledBeforeRenderError if view_context.nil?
+ __vc_original_view_context.#{helper_method}(*args, &block)
+ end
+ RUBY
+
+ ruby2_keywords(helper_method) if respond_to?(:ruby2_keywords, true)
+ end
+ end
+ end
+end
diff --git a/test/sandbox/app/components/current_page_component.rb b/test/sandbox/app/components/current_page_component.rb
index 559862199d..afd1c327e7 100644
--- a/test/sandbox/app/components/current_page_component.rb
+++ b/test/sandbox/app/components/current_page_component.rb
@@ -2,10 +2,6 @@
class CurrentPageComponent < ViewComponent::Base
def text
- if current_page?("/slots")
- "Inside /slots"
- else
- "Outside /slots"
- end
+ "#{current_page?("/slots") ? "Inside" : "Outside"} /slots (#{request.method} #{request.path})"
end
end
diff --git a/test/sandbox/app/components/use_helpers_component.html.erb b/test/sandbox/app/components/use_helpers_component.html.erb
new file mode 100644
index 0000000000..f24542007a
--- /dev/null
+++ b/test/sandbox/app/components/use_helpers_component.html.erb
@@ -0,0 +1,3 @@
+
diff --git a/test/sandbox/app/components/use_helpers_component.rb b/test/sandbox/app/components/use_helpers_component.rb
new file mode 100644
index 0000000000..375c07db63
--- /dev/null
+++ b/test/sandbox/app/components/use_helpers_component.rb
@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+class UseHelpersComponent < ViewComponent::Base
+ include ViewComponent::UseHelpers
+
+ use_helpers :message
+end
diff --git a/test/sandbox/config/routes.rb b/test/sandbox/config/routes.rb
index e921c0003d..afbb357be9 100644
--- a/test/sandbox/config/routes.rb
+++ b/test/sandbox/config/routes.rb
@@ -29,6 +29,7 @@
get :cached_partial, to: "integration_examples#cached_partial"
get :inherited_sidecar, to: "integration_examples#inherited_sidecar"
get :inherited_from_uncompilable_component, to: "integration_examples#inherited_from_uncompilable_component"
+ post :create, to: "integration_examples#create"
constraints(lambda { |request| request.env["warden"].authenticate! }) do
get :constraints_with_env, to: "integration_examples#index"
diff --git a/test/sandbox/test/preview_helper_test.rb b/test/sandbox/test/preview_helper_test.rb
index 108a8a71dd..5921a525d1 100644
--- a/test/sandbox/test/preview_helper_test.rb
+++ b/test/sandbox/test/preview_helper_test.rb
@@ -155,5 +155,37 @@ def test_raises_with_conflict_in_template_resolution
assert_equal("Found multiple templates for #{template_identifier}.", exception.message)
end
end
+
+ def test_prism_css_source_url_with_asset_pipeline
+ Rails.application.config.public_file_server.stub(:enabled, true) do
+ if Rails.version.to_f >= 6.1
+ assert_equal "/assets/prism.css", PreviewHelper.prism_css_source_url
+ else
+ assert_equal "/prism.css", PreviewHelper.prism_css_source_url
+ end
+ end
+ end
+
+ def test_prism_css_source_url_with_no_asset_pipeline
+ Rails.application.config.public_file_server.stub(:enabled, false) do
+ assert_equal "https://cdn.jsdelivr.net/npm/prismjs@1.28.0/themes/prism.min.css", PreviewHelper.prism_css_source_url
+ end
+ end
+
+ def test_prism_js_source_with_asset_pipeline
+ Rails.application.config.public_file_server.stub(:enabled, true) do
+ if Rails.version.to_f >= 6.1
+ assert_equal "/assets/prism.min.js", PreviewHelper.prism_js_source_url
+ else
+ assert_equal "/prism.min.js", PreviewHelper.prism_js_source_url
+ end
+ end
+ end
+
+ def test_prism_js_source_url_with_no_asset_pipeline
+ Rails.application.config.public_file_server.stub(:enabled, false) do
+ assert_equal "https://cdn.jsdelivr.net/npm/prismjs@1.28.0/prism.min.js", PreviewHelper.prism_js_source_url
+ end
+ end
end
end
diff --git a/test/sandbox/test/rendering_test.rb b/test/sandbox/test/rendering_test.rb
index 9e3de45bb2..95ebceee91 100644
--- a/test/sandbox/test/rendering_test.rb
+++ b/test/sandbox/test/rendering_test.rb
@@ -1095,6 +1095,11 @@ def test_content_security_policy_nonce
assert_selector("script", text: "\n//\n", visible: :hidden)
end
+ def test_use_helper
+ render_inline(UseHelpersComponent.new)
+ assert_selector ".helper__message", text: "Hello helper method"
+ end
+
def test_frozen_string_literal_disabled
old_value = ViewComponent::Base.config.frozen_string_literal
ViewComponent::Base.config.frozen_string_literal = false
diff --git a/test/sandbox/test/slotable_test.rb b/test/sandbox/test/slotable_test.rb
index 3a931167e6..086f418e59 100644
--- a/test/sandbox/test/slotable_test.rb
+++ b/test/sandbox/test/slotable_test.rb
@@ -719,4 +719,26 @@ def test_slot_with_content_shorthand
assert component.title.content?
end
+
+ def test_slot_names_cannot_start_with_call_
+ assert_raises ViewComponent::InvalidSlotNameError do
+ Class.new(ViewComponent::Base) do
+ renders_one :call_out_title
+ end
+ end
+
+ assert_raises ViewComponent::InvalidSlotNameError do
+ Class.new(ViewComponent::Base) do
+ renders_many :call_out_titles
+ end
+ end
+ end
+
+ def test_slot_names_can_start_with_call
+ assert_nothing_raised do
+ Class.new(ViewComponent::Base) do
+ renders_one :callhome_et
+ end
+ end
+ end
end
diff --git a/test/sandbox/test/test_helper_test.rb b/test/sandbox/test/test_helper_test.rb
index 90339a10fc..c55dfc0ebf 100644
--- a/test/sandbox/test/test_helper_test.rb
+++ b/test/sandbox/test/test_helper_test.rb
@@ -8,7 +8,7 @@ def test_with_request_url_inside_slots_path
render_inline(CurrentPageComponent.new)
end
- assert_selector("div", text: "Inside /slots")
+ assert_selector("div", text: "Inside /slots (GET /slots)")
end
def test_with_request_url_outside_slots_path
@@ -16,7 +16,15 @@ def test_with_request_url_outside_slots_path
render_inline(CurrentPageComponent.new)
end
- assert_selector("div", text: "Outside /slots")
+ assert_selector("div", text: "Outside /slots (GET /)")
+ end
+
+ def test_with_request_url_specifying_method
+ with_request_url "/create", method: "POST" do
+ render_inline(CurrentPageComponent.new)
+ end
+
+ assert_selector("div", text: "Outside /slots (POST /create)")
end
def test_with_request_url_under_constraint
diff --git a/test/view_component/engine_test.rb b/test/view_component/engine_test.rb
new file mode 100644
index 0000000000..5c5c037260
--- /dev/null
+++ b/test/view_component/engine_test.rb
@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require "test_helper"
+
+class ViewComponent::EngineTest < ActionDispatch::IntegrationTest
+ def test_serve_static_previews?
+ app.config.public_file_server.enabled = false
+ refute ViewComponent::Engine.instance.serve_static_preview_assets?(app.config)
+ end
+end