1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389
|
# frozen_string_literal: true
require "active_support/concern"
require "view_component/slot_v2"
module ViewComponent
module SlotableV2
extend ActiveSupport::Concern
RESERVED_NAMES = {
singular: %i[content render].freeze,
plural: %i[contents renders].freeze
}.freeze
# Setup component slot state
included do
# Hash of registered Slots
class_attribute :registered_slots
self.registered_slots = {}
class_attribute :_warn_on_deprecated_slot_setter
self._warn_on_deprecated_slot_setter = false
end
class_methods do
##
# Enables deprecations coming to the Slots API in ViewComponent v3
#
def warn_on_deprecated_slot_setter
self._warn_on_deprecated_slot_setter = true
end
##
# Registers a sub-component
#
# = Example
#
# renders_one :header -> (classes:) do
# HeaderComponent.new(classes: classes)
# end
#
# # OR
#
# renders_one :header, HeaderComponent
#
# where `HeaderComponent` is defined as:
#
# class HeaderComponent < ViewComponent::Base
# def initialize(classes:)
# @classes = classes
# end
# end
#
# and has the following template:
#
# <header class="<%= @classes %>">
# <%= content %>
# </header>
#
# = Rendering sub-component content
#
# The component's sidecar template can access the sub-component by calling a
# helper method with the same name as the sub-component.
#
# <h1>
# <%= header do %>
# My header title
# <% end %>
# </h1>
#
# = Setting sub-component content
#
# Consumers of the component can render a sub-component by calling a
# helper method with the same name as the slot prefixed with `with_`.
#
# <%= render_inline(MyComponent.new) do |component| %>
# <% component.with_header(classes: "Foo") do %>
# <p>Bar</p>
# <% end %>
# <% end %>
def renders_one(slot_name, callable = nil)
validate_singular_slot_name(slot_name)
validate_plural_slot_name(ActiveSupport::Inflector.pluralize(slot_name).to_sym)
define_method :"with_#{slot_name}" do |*args, &block|
set_slot(slot_name, nil, *args, &block)
end
ruby2_keywords(:"with_#{slot_name}") if respond_to?(:ruby2_keywords, true)
define_method slot_name do |*args, &block|
if args.empty? && block.nil?
get_slot(slot_name)
else
if _warn_on_deprecated_slot_setter
stack = caller_locations(3)
msg = "Setting a slot with `##{slot_name}` is deprecated and will be removed in ViewComponent v3.0.0. " \
"Use `#with_#{slot_name}` to set the slot instead."
ViewComponent::Deprecation.warn(msg, stack)
end
set_slot(slot_name, nil, *args, &block)
end
end
ruby2_keywords(slot_name.to_sym) if respond_to?(:ruby2_keywords, true)
define_method "#{slot_name}?" do
get_slot(slot_name).present?
end
register_slot(slot_name, collection: false, callable: callable)
end
##
# Registers a collection sub-component
#
# = Example
#
# renders_many :items, -> (name:) { ItemComponent.new(name: name }
#
# # OR
#
# renders_many :items, ItemComponent
#
# = Rendering sub-components
#
# The component's sidecar template can access the slot by calling a
# helper method with the same name as the slot.
#
# <h1>
# <% items.each do |item| %>
# <%= item %>
# <% end %>
# </h1>
#
# = Setting sub-component content
#
# Consumers of the component can set the content of a slot by calling a
# helper method with the same name as the slot prefixed with `with_`. The
# method can be called multiple times to append to the slot.
#
# <%= render_inline(MyComponent.new) do |component| %>
# <% component.with_item(name: "Foo") do %>
# <p>One</p>
# <% end %>
#
# <% component.with_item(name: "Bar") do %>
# <p>two</p>
# <% end %>
# <% end %>
def renders_many(slot_name, callable = nil)
singular_name = ActiveSupport::Inflector.singularize(slot_name)
validate_plural_slot_name(slot_name)
validate_singular_slot_name(ActiveSupport::Inflector.singularize(slot_name).to_sym)
# Define setter for singular names
# for example `renders_many :items` allows fetching all tabs with
# `component.tabs` and setting a tab with `component.tab`
define_method singular_name do |*args, &block|
if _warn_on_deprecated_slot_setter
ViewComponent::Deprecation.warn(
"Setting a slot with `##{singular_name}` is deprecated and will be removed in ViewComponent v3.0.0. " \
"Use `#with_#{singular_name}` to set the slot instead."
)
end
set_slot(slot_name, nil, *args, &block)
end
ruby2_keywords(singular_name.to_sym) if respond_to?(:ruby2_keywords, true)
define_method :"with_#{singular_name}" do |*args, &block|
set_slot(slot_name, nil, *args, &block)
end
ruby2_keywords(:"with_#{singular_name}") if respond_to?(:ruby2_keywords, true)
define_method :"with_#{slot_name}" do |collection_args = nil, &block|
collection_args.map do |args|
set_slot(slot_name, nil, **args, &block)
end
end
# Instantiates and and adds multiple slots forwarding the first
# argument to each slot constructor
define_method slot_name do |collection_args = nil, &block|
if collection_args.nil? && block.nil?
get_slot(slot_name)
else
if _warn_on_deprecated_slot_setter
ViewComponent::Deprecation.warn(
"Setting a slot with `##{slot_name}` is deprecated and will be removed in ViewComponent v3.0.0. " \
"Use `#with_#{slot_name}` to set the slot instead."
)
end
collection_args.map do |args|
set_slot(slot_name, nil, **args, &block)
end
end
end
define_method "#{slot_name}?" do
get_slot(slot_name).present?
end
register_slot(slot_name, collection: true, callable: callable)
end
def slot_type(slot_name)
registered_slot = registered_slots[slot_name]
if registered_slot
registered_slot[:collection] ? :collection : :single
else
plural_slot_name = ActiveSupport::Inflector.pluralize(slot_name).to_sym
plural_registered_slot = registered_slots[plural_slot_name]
plural_registered_slot&.fetch(:collection) ? :collection_item : nil
end
end
# Clone slot configuration into child class
# see #test_slots_pollution
def inherited(child)
child.registered_slots = registered_slots.clone
super
end
private
def register_slot(slot_name, **kwargs)
registered_slots[slot_name] = define_slot(slot_name, **kwargs)
end
def define_slot(slot_name, collection:, callable:)
# Setup basic slot data
slot = {
collection: collection
}
return slot unless callable
# If callable responds to `render_in`, we set it on the slot as a renderable
if callable.respond_to?(:method_defined?) && callable.method_defined?(:render_in)
slot[:renderable] = callable
elsif callable.is_a?(String)
# If callable is a string, we assume it's referencing an internal class
slot[:renderable_class_name] = callable
elsif callable.respond_to?(:call)
# If slot doesn't respond to `render_in`, we assume it's a proc,
# define a method, and save a reference to it to call when setting
method_name = :"_call_#{slot_name}"
define_method method_name, &callable
slot[:renderable_function] = instance_method(method_name)
else
raise(
ArgumentError,
"invalid slot definition. Please pass a class, string, or callable (i.e. proc, lambda, etc)"
)
end
slot
end
def validate_plural_slot_name(slot_name)
if RESERVED_NAMES[:plural].include?(slot_name.to_sym)
raise ArgumentError.new(
"#{self} 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."
)
end
raise_if_slot_ends_with_question_mark(slot_name)
raise_if_slot_registered(slot_name)
end
def validate_singular_slot_name(slot_name)
if slot_name.to_sym == :content
raise ArgumentError.new(
"#{self} declares a slot named content, which is a reserved word in ViewComponent.\n\n" \
"Content passed to a ViewComponent as a block is captured and assigned to the `content` accessor without having to create an explicit slot.\n\n" \
"To fix this issue, either use the `content` accessor directly or choose a different slot name."
)
end
if RESERVED_NAMES[:singular].include?(slot_name.to_sym)
raise ArgumentError.new(
"#{self} 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."
)
end
raise_if_slot_ends_with_question_mark(slot_name)
raise_if_slot_registered(slot_name)
end
def raise_if_slot_registered(slot_name)
if registered_slots.key?(slot_name)
# TODO remove? This breaks overriding slots when slots are inherited
raise ArgumentError.new(
"#{self} declares the #{slot_name} slot multiple times.\n\n" \
"To fix this issue, choose a different slot name."
)
end
end
def raise_if_slot_ends_with_question_mark(slot_name)
if slot_name.to_s.ends_with?("?")
raise ArgumentError.new(
"#{self} declares a slot named #{slot_name}, which ends with a question mark.\n\n" \
"This is not allowed because the ViewComponent framework already provides predicate " \
"methods ending in `?`.\n\n" \
"To fix this issue, choose a different name."
)
end
end
end
def get_slot(slot_name)
content unless content_evaluated? # ensure content is loaded so slots will be defined
slot = self.class.registered_slots[slot_name]
@__vc_set_slots ||= {}
if @__vc_set_slots[slot_name]
return @__vc_set_slots[slot_name]
end
if slot[:collection]
[]
end
end
def set_slot(slot_name, slot_definition = nil, *args, &block)
slot_definition ||= self.class.registered_slots[slot_name]
slot = SlotV2.new(self)
# Passing the block to the sub-component wrapper like this has two
# benefits:
#
# 1. If this is a `content_area` style sub-component, we will render the
# block via the `slot`
#
# 2. Since we've to pass block content to components when calling
# `render`, evaluating the block here would require us to call
# `view_context.capture` twice, which is slower
slot.__vc_content_block = block if block
# If class
if slot_definition[:renderable]
slot.__vc_component_instance = slot_definition[:renderable].new(*args)
# If class name as a string
elsif slot_definition[:renderable_class_name]
slot.__vc_component_instance =
self.class.const_get(slot_definition[:renderable_class_name]).new(*args)
# If passed a lambda
elsif slot_definition[:renderable_function]
# Use `bind(self)` to ensure lambda is executed in the context of the
# current component. This is necessary to allow the lambda to access helper
# methods like `content_tag` as well as parent component state.
renderable_function = slot_definition[:renderable_function].bind(self)
renderable_value =
if block
renderable_function.call(*args) do |*rargs|
view_context.capture(*rargs, &block)
end
else
renderable_function.call(*args)
end
# Function calls can return components, so if it's a component handle it specially
if renderable_value.respond_to?(:render_in)
slot.__vc_component_instance = renderable_value
else
slot.__vc_content = renderable_value
end
end
@__vc_set_slots ||= {}
if slot_definition[:collection]
@__vc_set_slots[slot_name] ||= []
@__vc_set_slots[slot_name].push(slot)
else
@__vc_set_slots[slot_name] = slot
end
slot
end
ruby2_keywords(:set_slot) if respond_to?(:ruby2_keywords, true)
end
end
|