/
base.rb
719 lines (607 loc) · 23.1 KB
/
base.rb
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
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
# frozen_string_literal: true
require "action_view"
require "active_support/configurable"
require "view_component/collection"
require "view_component/compile_cache"
require "view_component/compiler"
require "view_component/config"
require "view_component/errors"
require "view_component/inline_template"
require "view_component/preview"
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
class << self
delegate(*ViewComponent::Config.defaults.keys, to: :config)
# Returns the current config.
#
# @return [ActiveSupport::OrderedOptions]
def config
ViewComponent::Config.current
end
end
include ViewComponent::InlineTemplate
include ViewComponent::UseHelpers
include ViewComponent::Slotable
include ViewComponent::Translatable
include ViewComponent::WithContentHelper
RESERVED_PARAMETER = :content
# For CSRF authenticity tokens in forms
delegate :form_authenticity_token, :protect_against_forgery?, :config, to: :helpers
# For Content Security Policy nonces
delegate :content_security_policy_nonce, to: :helpers
# Config option that strips trailing whitespace in templates before compiling them.
class_attribute :__vc_strip_trailing_whitespace, instance_accessor: false, instance_predicate: false
self.__vc_strip_trailing_whitespace = false # class_attribute:default doesn't work until Rails 5.2
attr_accessor :__vc_original_view_context
# Components render in their own view context. Helpers and other functionality
# require a reference to the original Rails view context, an instance of
# `ActionView::Base`. Use this method to set a reference to the original
# view context. Objects that implement this method will render in the component's
# view context, while objects that don't will render in the original view context
# so helpers, etc work as expected.
#
# @param view_context [ActionView::Base] The original view context.
# @return [void]
def set_original_view_context(view_context)
self.__vc_original_view_context = view_context
end
# Entrypoint for rendering components.
#
# - `view_context`: ActionView context from calling view
# - `block`: optional block to be captured within the view context
#
# Returns HTML that has been escaped by the respective template handler.
#
# @return [String]
def render_in(view_context, &block)
self.class.compile(raise_errors: true)
@view_context = view_context
self.__vc_original_view_context ||= view_context
@output_buffer = ActionView::OutputBuffer.new
@lookup_context ||= view_context.lookup_context
# required for path helpers in older Rails versions
@view_renderer ||= view_context.view_renderer
# For content_for
@view_flow ||= view_context.view_flow
# For i18n
@virtual_path ||= virtual_path
# For template variants (+phone, +desktop, etc.)
@__vc_variant ||= @lookup_context.variants.first
# For caching, such as #cache_if
@current_template = nil unless defined?(@current_template)
old_current_template = @current_template
@current_template = self
if block && defined?(@__vc_content_set_by_with_content)
raise DuplicateContentError.new(self.class.name)
end
@__vc_content_evaluated = false
@__vc_render_in_block = block
before_render
if render?
# Avoid allocating new string when output_preamble and output_postamble are blank
rendered_template = safe_render_template_for(@__vc_variant).to_s
if output_preamble.blank? && output_postamble.blank?
rendered_template
else
safe_output_preamble + rendered_template + safe_output_postamble
end
else
""
end
ensure
@current_template = old_current_template
end
# Subclass components that call `super` inside their template code will cause a
# double render if they emit the result.
#
# ```erb
# <%= super %> # double-renders
# <% super %> # doesn't double-render
# ```
#
# `super` also doesn't consider the current variant. `render_parent` renders the
# parent template considering the current variant and emits the result without
# double-rendering.
def render_parent
render_parent_to_string
nil
end
# Renders the parent component to a string and returns it. This method is meant
# to be used inside custom #call methods when a string result is desired, eg.
#
# ```ruby
# def call
# "<div>#{render_parent_to_string}</div>"
# end
# ```
#
# When rendering the parent inside an .erb template, use `#render_parent` instead.
def render_parent_to_string
@__vc_parent_render_level ||= 0 # ensure a good starting value
begin
target_render = self.class.instance_variable_get(:@__vc_ancestor_calls)[@__vc_parent_render_level]
@__vc_parent_render_level += 1
target_render.bind_call(self, @__vc_variant)
ensure
@__vc_parent_render_level -= 1
end
end
# Optional content to be returned before the rendered template.
#
# @return [String]
def output_preamble
@@default_output_preamble ||= "".html_safe
end
# Optional content to be returned after the rendered template.
#
# @return [String]
def output_postamble
@@default_output_postamble ||= "".html_safe
end
# Called before rendering the component. Override to perform operations that
# depend on having access to the view context, such as helpers.
#
# @return [void]
def before_render
# noop
end
# Override to determine whether the ViewComponent should render.
#
# @return [Boolean]
def render?
true
end
# @private
def initialize(*)
end
# Re-use original view_context if we're not rendering a component.
#
# This prevents an exception when rendering a partial inside of a component that has also been rendered outside
# of the component. This is due to the partials compiled template method existing in the parent `view_context`,
# and not the component's `view_context`.
#
# @private
def render(options = {}, args = {}, &block)
if options.respond_to?(:set_original_view_context)
options.set_original_view_context(self.__vc_original_view_context)
super
else
__vc_original_view_context.render(options, args, &block)
end
end
# The current controller. Use sparingly as doing so introduces coupling
# that inhibits encapsulation & reuse, often making testing difficult.
#
# @return [ActionController::Base]
def controller
raise ControllerCalledBeforeRenderError if view_context.nil?
@__vc_controller ||= view_context.controller
end
# A proxy through which to access helpers. Use sparingly as doing so introduces
# coupling that inhibits encapsulation & reuse, often making testing difficult.
#
# @return [ActionView::Base]
def helpers
raise HelpersCalledBeforeRenderError if view_context.nil?
# Attempt to re-use the original view_context passed to the first
# component rendered in the rendering pipeline. This prevents the
# instantiation of a new view_context via `controller.view_context` which
# always returns a new instance of the view context class.
#
# This allows ivars to remain persisted when using the same helper via
# `helpers` across multiple components and partials.
@__vc_helpers ||= __vc_original_view_context || controller.view_context
end
if ::Rails.env.development? || ::Rails.env.test?
# @private
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
def virtual_path
self.class.virtual_path
end
# For caching, such as #cache_if
# @private
def view_cache_dependencies
[]
end
# For caching, such as #cache_if
#
# @private
def format
@__vc_variant if defined?(@__vc_variant)
end
# The current request. Use sparingly as doing so introduces coupling that
# inhibits encapsulation & reuse, often making testing difficult.
#
# @return [ActionDispatch::Request]
def request
@request ||= controller.request if controller.respond_to?(:request)
end
# The content passed to the component instance as a block.
#
# @return [String]
def content
@__vc_content_evaluated = true
return @__vc_content if defined?(@__vc_content)
@__vc_content =
if __vc_render_in_block_provided?
view_context.capture(self, &@__vc_render_in_block)
elsif __vc_content_set_by_with_content_defined?
@__vc_content_set_by_with_content
end
end
# Whether `content` has been passed to the component.
#
# @return [Boolean]
def content?
__vc_render_in_block_provided? || __vc_content_set_by_with_content_defined?
end
private
attr_reader :view_context
def __vc_render_in_block_provided?
defined?(@view_context) && @view_context && @__vc_render_in_block
end
def __vc_content_set_by_with_content_defined?
defined?(@__vc_content_set_by_with_content)
end
def content_evaluated?
defined?(@__vc_content_evaluated) && @__vc_content_evaluated
end
def maybe_escape_html(text)
return text if request && !request.format.html?
return text if text.blank?
if text.html_safe?
text
else
yield
html_escape(text)
end
end
def safe_render_template_for(variant)
if compiler.renders_template_for_variant?(variant)
render_template_for(variant)
else
maybe_escape_html(render_template_for(variant)) do
Kernel.warn("WARNING: The #{self.class} component rendered HTML-unsafe output. The output will be automatically escaped, but you may want to investigate.")
end
end
end
def safe_output_preamble
maybe_escape_html(output_preamble) do
Kernel.warn("WARNING: The #{self.class} component was provided an HTML-unsafe preamble. The preamble will be automatically escaped, but you may want to investigate.")
end
end
def safe_output_postamble
maybe_escape_html(output_postamble) do
Kernel.warn("WARNING: The #{self.class} component was provided an HTML-unsafe postamble. The postamble will be automatically escaped, but you may want to investigate.")
end
end
def compiler
@compiler ||= self.class.compiler
end
# Set the controller used for testing components:
#
# ```ruby
# config.view_component.test_controller = "MyTestController"
# ```
#
# Defaults to `nil`. If this is falsy, `"ApplicationController"` is used. Can also be
# configured on a per-test basis using `with_controller_class`.
#
# Set if render monkey patches should be included or not in Rails <6.1:
#
# ```ruby
# config.view_component.render_monkey_patch_enabled = false
# ```
#
# Path for component files
#
# ```ruby
# config.view_component.view_component_path = "app/my_components"
# ```
#
# Defaults to `nil`. If this is falsy, `app/components` is used.
#
# Parent class for generated components
#
# ```ruby
# config.view_component.component_parent_class = "MyBaseComponent"
# ```
#
# Defaults to nil. If this is falsy, generators will use
# "ApplicationComponent" if defined, "ViewComponent::Base" otherwise.
#
# Configuration for generators.
#
# All options under this namespace default to `false` unless otherwise
# stated.
#
# #### #sidecar
#
# Always generate a component with a sidecar directory:
#
# ```ruby
# config.view_component.generate.sidecar = true
# ```
#
# #### #stimulus_controller
#
# Always generate a Stimulus controller alongside the component:
#
# ```ruby
# config.view_component.generate.stimulus_controller = true
# ```
#
# #### #locale
#
# Always generate translations file alongside the component:
#
# ```ruby
# config.view_component.generate.locale = true
# ```
#
# #### #distinct_locale_files
#
# Always generate as many translations files as available locales:
#
# ```ruby
# config.view_component.generate.distinct_locale_files = true
# ```
#
# One file will be generated for each configured `I18n.available_locales`,
# falling back to `[:en]` when no `available_locales` is defined.
#
# #### #preview
#
# Always generate preview alongside the component:
#
# ```ruby
# config.view_component.generate.preview = true
# ```
#
# Defaults to `false`.
class << self
# @private
attr_accessor :source_location, :virtual_path
# Find sidecar files for the given extensions.
#
# The provided array of extensions is expected to contain
# strings starting without the dot, example: `["erb", "haml"]`.
#
# For example, one might collect sidecar CSS files that need to be compiled.
# @param extensions [Array<String>] Extensions of which to return matching sidecar files.
def sidecar_files(extensions)
return [] unless source_location
extensions = extensions.join(",")
# view files in a directory named like the component
directory = File.dirname(source_location)
filename = File.basename(source_location, ".rb")
component_name = name.demodulize.underscore
# Add support for nested components defined in the same file.
#
# for example
#
# class MyComponent < ViewComponent::Base
# class MyOtherComponent < ViewComponent::Base
# end
# end
#
# Without this, `MyOtherComponent` will not look for `my_component/my_other_component.html.erb`
nested_component_files =
if name.include?("::") && component_name != filename
Dir["#{directory}/#{filename}/#{component_name}.*{#{extensions}}"]
else
[]
end
# view files in the same directory as the component
sidecar_files = Dir["#{directory}/#{component_name}.*{#{extensions}}"]
sidecar_directory_files = Dir["#{directory}/#{component_name}/#{filename}.*{#{extensions}}"]
(sidecar_files - [source_location] + sidecar_directory_files + nested_component_files).uniq
end
# Render a component for each element in a collection ([documentation](/guide/collections)):
#
# ```ruby
# render(ProductsComponent.with_collection(@products, foo: :bar))
# ```
#
# @param collection [Enumerable] A list of items to pass the ViewComponent one at a time.
# @param args [Arguments] Arguments to pass to the ViewComponent every time.
def with_collection(collection, **args)
Collection.new(self, collection, **args)
end
# Provide identifier for ActionView template annotations
#
# @private
def short_identifier
@short_identifier ||= defined?(Rails.root) ? source_location.sub("#{Rails.root}/", "") : source_location
end
# @private
def inherited(child)
# Compile so child will inherit compiled `call_*` template methods that
# `compile` defines
compile
# Give the child its own personal #render_template_for to protect against the case when
# eager loading is disabled and the parent component is rendered before the child. In
# such a scenario, the parent will override ViewComponent::Base#render_template_for,
# meaning it will not be called for any children and thus not compile their templates.
if !child.instance_methods(false).include?(:render_template_for) && !child.compiled?
child.class_eval <<~RUBY, __FILE__, __LINE__ + 1
def render_template_for(variant = nil)
# Force compilation here so the compiler always redefines render_template_for.
# This is mostly a safeguard to prevent infinite recursion.
self.class.compile(raise_errors: true, force: true)
# .compile replaces this method; call the new one
render_template_for(variant)
end
RUBY
end
# If Rails application is loaded, add application url_helpers to the component context
# we need to check this to use this gem as a dependency
if defined?(Rails) && Rails.application && !(child < Rails.application.routes.url_helpers)
child.include Rails.application.routes.url_helpers
end
# Derive the source location of the component Ruby file from the call stack.
# We need to ignore `inherited` frames here as they indicate that `inherited`
# has been re-defined by the consuming application, likely in ApplicationComponent.
# We use `base_label` method here instead of `label` to avoid cases where the method
# owner is included in a prefix like `ApplicationComponent.inherited`.
child.source_location = caller_locations(1, 10).reject { |l| l.base_label == "inherited" }[0].path
# If Rails application is loaded, removes the first part of the path and the extension.
if defined?(Rails) && Rails.application
child.virtual_path = child.source_location.gsub(
/(.*#{Regexp.quote(ViewComponent::Base.config.view_component_path)})|(\.rb)/, ""
)
end
# Set collection parameter to the extended component
child.with_collection_parameter provided_collection_parameter
if instance_methods(false).include?(:render_template_for)
vc_ancestor_calls = defined?(@__vc_ancestor_calls) ? @__vc_ancestor_calls.dup : []
vc_ancestor_calls.unshift(instance_method(:render_template_for))
child.instance_variable_set(:@__vc_ancestor_calls, vc_ancestor_calls)
end
super
end
# @private
def compiled?
compiler.compiled?
end
# @private
def ensure_compiled
compile unless compiled?
end
# Compile templates to instance methods, assuming they haven't been compiled already.
#
# Do as much work as possible in this step, as doing so reduces the amount
# of work done each time a component is rendered.
# @private
def compile(raise_errors: false, force: false)
compiler.compile(raise_errors: raise_errors, force: force)
end
# @private
def compiler
@__vc_compiler ||= Compiler.new(self)
end
# we'll eventually want to update this to support other types
# @private
def type
"text/html"
end
# @private
def format
:html
end
# @private
def identifier
source_location
end
# Set the parameter name used when rendering elements of a collection ([documentation](/guide/collections)):
#
# ```ruby
# with_collection_parameter :item
# ```
#
# @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.
#
# ```ruby
# class MyComponent < ViewComponent::Base
# strip_trailing_whitespace
# end
# ```
#
# @param value [Boolean] Whether to strip newlines.
def strip_trailing_whitespace(value = true)
self.__vc_strip_trailing_whitespace = value
end
# Whether trailing whitespace will be stripped before compilation.
#
# @return [Boolean]
def strip_trailing_whitespace?
__vc_strip_trailing_whitespace
end
# Ensure the component initializer accepts the
# collection parameter. By default, we don't
# validate that the default parameter name
# is accepted, as support for collection
# rendering is optional.
# @private TODO: add documentation
def validate_collection_parameter!(validate_default: false)
parameter = validate_default ? collection_parameter : provided_collection_parameter
return unless parameter
return if initialize_parameter_names.include?(parameter) || splatted_keyword_argument_present?
# If Ruby can't parse the component class, then the initialize
# parameters will be empty and ViewComponent will not be able to render
# the component.
if initialize_parameters.empty?
raise EmptyOrInvalidInitializerError.new(name, parameter)
end
raise MissingCollectionArgumentError.new(name, parameter)
end
# Ensure the component initializer doesn't define
# invalid parameters that could override the framework's
# methods.
# @private TODO: add documentation
def validate_initialization_parameters!
return unless initialize_parameter_names.include?(RESERVED_PARAMETER)
raise ReservedParameterError.new(name, RESERVED_PARAMETER)
end
# @private
def collection_parameter
provided_collection_parameter || name && name.demodulize.underscore.chomp("_component").to_sym
end
# @private
def collection_counter_parameter
:"#{collection_parameter}_counter"
end
# @private
def counter_argument_present?
initialize_parameter_names.include?(collection_counter_parameter)
end
# @private
def collection_iteration_parameter
:"#{collection_parameter}_iteration"
end
# @private
def iteration_argument_present?
initialize_parameter_names.include?(collection_iteration_parameter)
end
private
def splatted_keyword_argument_present?
initialize_parameters.flatten.include?(:keyrest) &&
!initialize_parameters.include?([:keyrest, :**]) # Un-named splatted keyword args don't count!
end
def initialize_parameter_names
return attribute_names.map(&:to_sym) if respond_to?(:attribute_names)
return attribute_types.keys.map(&:to_sym) if Rails::VERSION::MAJOR <= 5 && respond_to?(:attribute_types)
initialize_parameters.map(&:last)
end
def initialize_parameters
@initialize_parameters ||= instance_method(:initialize).parameters
end
def provided_collection_parameter
@provided_collection_parameter ||= nil
end
end
ActiveSupport.run_load_hooks(:view_component, self)
end
end