view_component 4.17.0 → 4.24.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (39) hide show
  1. checksums.yaml +4 -4
  2. data/app/views/test_mailer/test_multipart_email.html.erb +1 -0
  3. data/app/views/test_mailer/test_multipart_email.text.erb +1 -0
  4. data/docs/CHANGELOG.md +234 -0
  5. data/lib/generators/view_component/abstract_generator.rb +24 -4
  6. data/lib/generators/view_component/component/component_generator.rb +8 -6
  7. data/lib/generators/view_component/component/templates/component.rb.tt +1 -1
  8. data/lib/generators/view_component/erb/erb_generator.rb +2 -2
  9. data/lib/generators/view_component/haml/haml_generator.rb +1 -1
  10. data/lib/generators/view_component/locale/locale_generator.rb +2 -6
  11. data/lib/generators/view_component/preview/preview_generator.rb +9 -6
  12. data/lib/generators/view_component/preview/templates/component_preview.rb.tt +2 -2
  13. data/lib/generators/view_component/rspec/rspec_generator.rb +1 -1
  14. data/lib/generators/view_component/rspec/templates/component_spec.rb.tt +1 -1
  15. data/lib/generators/view_component/slim/slim_generator.rb +1 -1
  16. data/lib/generators/view_component/stimulus/stimulus_generator.rb +3 -7
  17. data/lib/generators/view_component/test_unit/templates/component_test.rb.tt +2 -2
  18. data/lib/generators/view_component/test_unit/test_unit_generator.rb +8 -7
  19. data/lib/view_component/base.rb +169 -94
  20. data/lib/view_component/cache_digest/dependency_tracking.rb +43 -11
  21. data/lib/view_component/cache_digest/digestor_lookup.rb +77 -0
  22. data/lib/view_component/cache_digest/resolver.rb +163 -65
  23. data/lib/view_component/cache_digest.rb +384 -75
  24. data/lib/view_component/{experimentally_cacheable.rb → cacheable.rb} +50 -127
  25. data/lib/view_component/collection.rb +4 -9
  26. data/lib/view_component/compile_cache.rb +63 -3
  27. data/lib/view_component/compiler.rb +86 -15
  28. data/lib/view_component/config.rb +114 -8
  29. data/lib/view_component/engine.rb +18 -6
  30. data/lib/view_component/errors.rb +16 -0
  31. data/lib/view_component/request_details.rb +5 -10
  32. data/lib/view_component/slot.rb +17 -0
  33. data/lib/view_component/slotable.rb +32 -8
  34. data/lib/view_component/template.rb +38 -16
  35. data/lib/view_component/test_helpers.rb +39 -15
  36. data/lib/view_component/translatable.rb +35 -1
  37. data/lib/view_component/version.rb +1 -1
  38. data/lib/view_component.rb +1 -1
  39. metadata +10 -7
@@ -1,9 +1,102 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require "view_component/deprecation"
3
+ require "view_component/errors"
4
4
 
5
5
  module ViewComponent
6
6
  class Config
7
+ # An `ActiveSupport::OrderedOptions` that raises when an option it doesn't
8
+ # know about is set, rather than silently storing it.
9
+ class Options < ActiveSupport::OrderedOptions # :nodoc:
10
+ ROOT_NAMESPACE = "config.view_component"
11
+
12
+ def initialize(namespace, allowed_keys, default: nil, renamed: {}, removed: {})
13
+ super(default)
14
+ @namespace = namespace
15
+ @allowed_keys = allowed_keys
16
+ @renamed = renamed
17
+ @removed = removed
18
+ @nested_options = {}
19
+ end
20
+
21
+ def []=(key, value)
22
+ key = key.to_sym
23
+
24
+ if @allowed_keys.include?(key)
25
+ @nested_options[key] ||= value if value.is_a?(Options)
26
+ if (nested_options = @nested_options[key])
27
+ raise TypeError, "#{@namespace}.#{key} must be a Hash" unless value.is_a?(Hash)
28
+
29
+ value = nested_options.dup.clear.tap do |options|
30
+ value.each_pair { |nested_key, nested_value| options[nested_key] = nested_value }
31
+ end
32
+ end
33
+
34
+ super
35
+ else
36
+ raise UnknownConfigOptionError.new(
37
+ "#{@namespace}.#{key}",
38
+ renamed_to: @renamed[key] && "#{ROOT_NAMESPACE}.#{@renamed[key]}",
39
+ removed: @removed.key?(key),
40
+ hint: @removed[key],
41
+ valid_options: @allowed_keys
42
+ )
43
+ end
44
+ end
45
+
46
+ alias_method :store, :[]=
47
+
48
+ def merge!(*others)
49
+ others.each do |other|
50
+ {}.merge!(other).each_pair do |key, value|
51
+ key = key.to_sym
52
+ value = yield(key, self[key], value) if block_given? && key?(key)
53
+ self[key] = value
54
+ end
55
+ end
56
+ self
57
+ end
58
+
59
+ alias_method :update, :merge!
60
+
61
+ def replace(other)
62
+ replacement = dup.clear
63
+ replacement.merge!(other)
64
+ super(replacement)
65
+ end
66
+
67
+ def transform_keys!(*args, &block)
68
+ return enum_for(:transform_keys!) if args.empty? && !block
69
+
70
+ replace(to_h.transform_keys!(*args, &block))
71
+ end
72
+
73
+ def transform_values!(&block)
74
+ return enum_for(:transform_values!) unless block
75
+
76
+ replace(to_h.transform_values!(&block))
77
+ end
78
+ end
79
+
80
+ # Options renamed in 4.0, mapped to their new name.
81
+ RENAMED_OPTIONS = {
82
+ preview_controller: "previews.controller",
83
+ preview_route: "previews.route",
84
+ preview_paths: "previews.paths",
85
+ show_previews: "previews.enabled",
86
+ default_preview_layout: "previews.default_layout",
87
+ component_parent_class: "generate.parent_class",
88
+ view_component_path: "generate.path"
89
+ }.freeze
90
+
91
+ # Options removed in 4.0, mapped to a hint about what to do instead.
92
+ REMOVED_OPTIONS = {
93
+ test_controller: "Use the `vc_test_controller_class` test helper instead.",
94
+ render_monkey_patch_enabled: nil,
95
+ use_deprecated_instrumentation_name: "Events always use the `render.view_component` name.",
96
+ capture_compatibility_patch_enabled: nil,
97
+ show_previews_source: "Consider using Lookbook instead."
98
+ }.freeze
99
+
7
100
  class << self
8
101
  # `new` without any arguments initializes the default configuration, but
9
102
  # it's important to differentiate in case that's no longer the case in
@@ -11,11 +104,16 @@ module ViewComponent
11
104
  alias_method :default, :new
12
105
 
13
106
  def defaults
14
- ActiveSupport::OrderedOptions.new.merge!({
15
- generate: default_generate_options,
16
- previews: default_previews_options,
17
- instrumentation_enabled: false
18
- })
107
+ options = Options.new(
108
+ Options::ROOT_NAMESPACE,
109
+ %i[generate previews instrumentation_enabled],
110
+ renamed: RENAMED_OPTIONS,
111
+ removed: REMOVED_OPTIONS
112
+ )
113
+ options.generate = default_generate_options
114
+ options.previews = default_previews_options
115
+ options.instrumentation_enabled = false
116
+ options
19
117
  end
20
118
 
21
119
  # @!attribute generate
@@ -156,14 +254,22 @@ module ViewComponent
156
254
  end
157
255
 
158
256
  def default_generate_options
159
- options = ActiveSupport::OrderedOptions.new(false)
257
+ options = Options.new(
258
+ "#{Options::ROOT_NAMESPACE}.generate",
259
+ %i[path preview_path parent_class sidecar stimulus_controller typescript locale distinct_locale_files preview use_component_path_for_rspec_tests],
260
+ default: false,
261
+ renamed: {component_parent_class: RENAMED_OPTIONS.fetch(:component_parent_class)}
262
+ )
160
263
  options.preview_path = ""
161
264
  options.path = "app/components"
162
265
  options
163
266
  end
164
267
 
165
268
  def default_previews_options
166
- options = ActiveSupport::OrderedOptions.new
269
+ options = Options.new(
270
+ "#{Options::ROOT_NAMESPACE}.previews",
271
+ %i[controller route enabled default_layout paths]
272
+ )
167
273
  options.controller = "ViewComponentsController"
168
274
  options.route = "/rails/view_components"
169
275
  options.enabled = defined?(Rails.env) && (Rails.env.development? || Rails.env.test?)
@@ -3,11 +3,16 @@
3
3
  require "rails"
4
4
  require "view_component/config"
5
5
  require "view_component/deprecation"
6
+ require "view_component/cache_digest"
6
7
 
7
8
  module ViewComponent
8
9
  class Engine < Rails::Engine # :nodoc:
9
10
  config.view_component = ViewComponent::Config.current
10
11
 
12
+ initializer "view_component.cache_digest" do
13
+ ViewComponent::CacheDigest.install!
14
+ end
15
+
11
16
  initializer "view_component.set_configs" do |app|
12
17
  options = app.config.view_component
13
18
 
@@ -89,10 +94,16 @@ module ViewComponent
89
94
  ActiveSupport.on_load(:after_initialize) do
90
95
  if Rails.application.config.eager_load
91
96
  ActiveSupport::Notifications.instrument("compile.view_component") do
92
- ViewComponent::Base.descendants.each do |component|
93
- next if component.anonymous?
97
+ CompileCache.with_sidecar_files_cache do
98
+ components = ViewComponent::Base.descendants.reject(&:anonymous?)
99
+
100
+ ViewComponent::CacheDigest.retaining_compiled_sources do
101
+ components.each(&:__vc_compile)
94
102
 
95
- component.__vc_compile
103
+ if ActionView::Base.cache_template_loading
104
+ ViewComponent::CacheDigest.precompute!(components.select(&:__vc_compiled?))
105
+ end
106
+ end
96
107
  end
97
108
  end
98
109
  end
@@ -139,10 +150,11 @@ module ViewComponent
139
150
  ActiveSupport.on_load(:action_view) do
140
151
  next if ActionView::Base.cache_template_loading
141
152
 
142
- template_watcher = nil
153
+ template_watcher = CompileCache.template_watcher(app.config.file_watcher)
143
154
 
144
- app.executor.to_run :before do
145
- template_watcher ||= CompileCache.template_watcher(app.config.file_watcher)
155
+ app.reloaders << template_watcher
156
+ app.reloader.to_run do
157
+ require_unload_lock!
146
158
  template_watcher.execute_if_updated
147
159
  end
148
160
  end
@@ -267,4 +267,20 @@ module ViewComponent
267
267
  super(MESSAGE.gsub("COMPONENT", component_name.to_s))
268
268
  end
269
269
  end
270
+
271
+ class UnknownConfigOptionError < StandardError
272
+ def initialize(option, renamed_to: nil, removed: false, hint: nil, valid_options: [])
273
+ message =
274
+ if renamed_to
275
+ "`#{option}` was renamed to `#{renamed_to}` in ViewComponent 4.0."
276
+ elsif removed
277
+ "`#{option}` was removed in ViewComponent 4.0."
278
+ else
279
+ "`#{option}` isn't a ViewComponent configuration option. " \
280
+ "Valid options are: #{valid_options.join(", ")}."
281
+ end
282
+
283
+ super([message, hint].compact.join(" "))
284
+ end
285
+ end
270
286
  end
@@ -25,16 +25,11 @@ module ViewComponent
25
25
  # `render` accepts, but there's currently no mechanism for users to
26
26
  # provide these when calling render on a ViewComponent.
27
27
  if user_details.equal?(EMPTY_DETAILS)
28
- # Fast path: memoize the empty-details Requested per LookupContext.
29
- # Rendered many times with the same context, the tuple/Requested
30
- # allocations from ActionView are then paid at most once.
31
- cached = instance_variable_defined?(:@__vc_requested_details_cache) &&
32
- @__vc_requested_details_cache
33
- return cached if cached
34
-
35
- details, from_cache = detail_args_for(EMPTY_DETAILS)
36
- @__vc_requested_details_cache =
37
- from_cache || ActionView::TemplateDetails::Requested.new(**details)
28
+ # Fast path: with template caching on, `details_key` is the
29
+ # Requested for the current details, memoized by ActionView and
30
+ # reset whenever a detail such as `formats` changes. Using it
31
+ # directly skips the tuple `detail_args_for` allocates.
32
+ details_key || ActionView::TemplateDetails::Requested.new(**@details)
38
33
  else
39
34
  details, from_cache = detail_args_for(user_details)
40
35
  from_cache || ActionView::TemplateDetails::Requested.new(**details)
@@ -12,6 +12,18 @@ module ViewComponent
12
12
  @parent = parent
13
13
  end
14
14
 
15
+ # @private
16
+ def __vc_dup(parent)
17
+ dup.tap do |copy|
18
+ copy.instance_variable_set(:@parent, parent)
19
+ copy.remove_instance_variable(:@content) if defined?(@content)
20
+ if __vc_component_instance?
21
+ component = @__vc_component_instance
22
+ copy.__vc_component_instance = component.is_a?(Base) ? component.__vc_dup_for_render : component.dup
23
+ end
24
+ end
25
+ end
26
+
15
27
  def content?
16
28
  return true if defined?(@__vc_content) && @__vc_content.present?
17
29
  return true if defined?(@__vc_content_set_by_with_content) && @__vc_content_set_by_with_content.present?
@@ -96,7 +108,12 @@ module ViewComponent
96
108
  # end
97
109
  # end
98
110
  # end
111
+ #
112
+ # A slot that doesn't wrap a component raises `NoMethodError` for
113
+ # undefined methods, like any other object.
99
114
  def method_missing(symbol, *args, **kwargs, &block)
115
+ return super unless __vc_component_instance?
116
+
100
117
  @__vc_component_instance.public_send(symbol, *args, **kwargs, &block)
101
118
  end
102
119
 
@@ -216,9 +216,9 @@ module ViewComponent
216
216
  def __vc_register_default_slots
217
217
  registered_slots.each do |slot_name, config|
218
218
  default_method_name = :"default_#{slot_name}"
219
- config[:default_method] = instance_methods.find { |method_name| method_name == default_method_name }
220
-
221
- registered_slots[slot_name] = config
219
+ registered_slots[slot_name] = config.merge(
220
+ default_method: method_defined?(default_method_name) ? default_method_name : nil
221
+ )
222
222
  end
223
223
  end
224
224
 
@@ -361,6 +361,9 @@ module ViewComponent
361
361
 
362
362
  # If there is a default method for the slot, call it
363
363
  if (default_method = registered_slots[slot_name][:default_method])
364
+ @__vc_default_slots ||= {}
365
+ return @__vc_default_slots[slot_name] if @__vc_default_slots.key?(slot_name)
366
+
364
367
  renderable_value = send(default_method)
365
368
  slot = Slot.new(self)
366
369
 
@@ -370,13 +373,34 @@ module ViewComponent
370
373
  slot.__vc_content = renderable_value
371
374
  end
372
375
 
373
- slot
376
+ @__vc_default_slots[slot_name] = slot
374
377
  elsif self.class.registered_slots[slot_name][:collection]
375
378
  # If empty slot is a collection, return an empty array
376
379
  []
377
380
  end
378
381
  end
379
382
 
383
+ # @private
384
+ # Collection spacers need independent slots whose parent is the new copy.
385
+ def __vc_dup_for_render
386
+ __vc_check_reused_instance!
387
+
388
+ dup.tap do |copy|
389
+ %i[@__vc_set_slots @__vc_default_slots].each do |variable|
390
+ next unless instance_variable_defined?(variable)
391
+
392
+ slots = instance_variable_get(variable).transform_values do |slot|
393
+ if slot.is_a?(Array)
394
+ slot.map { |item| item.__vc_dup(copy) }
395
+ else
396
+ slot.__vc_dup(copy)
397
+ end
398
+ end
399
+ copy.instance_variable_set(variable, slots)
400
+ end
401
+ end
402
+ end
403
+
380
404
  def __vc_set_slot(slot_name, slot_definition = nil, *args, **kwargs, &block)
381
405
  slot_definition ||= self.class.registered_slots[slot_name]
382
406
  slot = Slot.new(self)
@@ -408,19 +432,19 @@ module ViewComponent
408
432
  self.class.const_get(slot_definition[:renderable_class_name]).new(*args, **kwargs)
409
433
  # If passed a lambda
410
434
  elsif slot_definition[:renderable_function]
411
- # Use `bind(self)` to ensure lambda is executed in the context of the
435
+ # Use `bind_call(self)` to ensure lambda is executed in the context of the
412
436
  # current component. This is necessary to allow the lambda to access helper
413
437
  # methods like `content_tag` as well as parent component state.
414
- renderable_function = slot_definition[:renderable_function].bind(self)
438
+ renderable_function = slot_definition[:renderable_function]
415
439
  renderable_value =
416
440
  if block
417
- renderable_function.call(*args, **kwargs) do |*rargs|
441
+ renderable_function.bind_call(self, *args, **kwargs) do |*rargs|
418
442
  with_captured_virtual_path(captured_block_virtual_path) do
419
443
  view_context.capture(*rargs, &block)
420
444
  end
421
445
  end
422
446
  else
423
- renderable_function.call(*args, **kwargs)
447
+ renderable_function.bind_call(self, *args, **kwargs)
424
448
  end
425
449
 
426
450
  # Function calls can return components, so if it's a component handle it specially
@@ -5,6 +5,10 @@ module ViewComponent
5
5
  DEFAULT_FORMAT = :html
6
6
  private_constant :DEFAULT_FORMAT
7
7
 
8
+ # Rails 8.1 added a newline to compiled ERB output (rails/rails#53731).
9
+ ERB_NEWLINE_RAILS_VERSION = Gem::Version.new("8.1.0.alpha")
10
+ private_constant :ERB_NEWLINE_RAILS_VERSION
11
+
8
12
  DataWithSource = Struct.new(:format, :identifier, :short_identifier, :type)
9
13
 
10
14
  attr_reader :details, :path
@@ -35,9 +39,9 @@ module ViewComponent
35
39
  :file
36
40
  end
37
41
 
38
- # Load file each time we look up #source in case the file has been modified
42
+ # Only reuse file contents while eager loading; otherwise reflect edits.
39
43
  def source
40
- ::File.read(@path)
44
+ CompileCache.read_file(@path)
41
45
  end
42
46
 
43
47
  private
@@ -123,14 +127,13 @@ module ViewComponent
123
127
  @component.define_method(safe_method_name, @component.instance_method(@call_method_name))
124
128
  end
125
129
 
126
- def safe_method_name_call
127
- m = safe_method_name
128
- proc do
129
- __vc_maybe_escape_html(send(m)) do
130
- Kernel.warn("WARNING: The #{self.class} component rendered HTML-unsafe output. " \
130
+ def safe_method_call
131
+ <<~RUBY
132
+ __vc_maybe_escape_html(#{super}) do
133
+ Kernel.warn("WARNING: The \#{self.class} component rendered HTML-unsafe output. " \
131
134
  "The output will be automatically escaped, but you may want to investigate.")
132
135
  end
133
- end
136
+ RUBY
134
137
  end
135
138
 
136
139
  def defined_on_self?
@@ -138,6 +141,19 @@ module ViewComponent
138
141
  end
139
142
  end
140
143
 
144
+ class Inherited < InlineCall
145
+ def initialize(component:, template:)
146
+ super(component: component, method_name: template.call_method_name, defined_on_self: false)
147
+ @details = template.details
148
+ @path = template.path
149
+ @template = template
150
+ end
151
+
152
+ def compile_to_component
153
+ @component.define_method(safe_method_name, @component.instance_method(@template.safe_method_name))
154
+ end
155
+ end
156
+
141
157
  def compile_to_component
142
158
  @component.silence_redefinition_of_method(call_method_name)
143
159
 
@@ -156,9 +172,13 @@ module ViewComponent
156
172
  defined?(Coverage) && Coverage.running?
157
173
  end
158
174
 
159
- def safe_method_name_call
160
- m = safe_method_name
161
- proc { send(m) }
175
+ def safe_method_call
176
+ method_name = safe_method_name
177
+ if /\A[a-zA-Z_]\w*[!?]?\z/.match?(method_name)
178
+ method_name
179
+ else
180
+ "send(#{method_name.to_sym.inspect})"
181
+ end
162
182
  end
163
183
 
164
184
  def requires_compiled_superclass?
@@ -181,7 +201,7 @@ module ViewComponent
181
201
  end
182
202
 
183
203
  def safe_method_name
184
- "_#{call_method_name}_#{@component.name.underscore.gsub("/", "__")}"
204
+ "_#{call_method_name}_#{format}_#{@component.name.underscore.gsub("/", "__")}"
185
205
  end
186
206
 
187
207
  def normalized_variant_name
@@ -193,7 +213,7 @@ module ViewComponent
193
213
  attr_reader :lineno
194
214
 
195
215
  def erb_newline_compensation_needed?
196
- Rails::VERSION::MAJOR >= 8 && Rails::VERSION::MINOR > 0 &&
216
+ Rails.gem_version >= ERB_NEWLINE_RAILS_VERSION &&
197
217
  details.handler == :erb &&
198
218
  annotated?
199
219
  end
@@ -208,14 +228,16 @@ module ViewComponent
208
228
 
209
229
  def compiled_source
210
230
  handler = details.handler_class
211
- this_source = source
212
- this_source.rstrip! if @component.strip_trailing_whitespace?
231
+ original_source = source
232
+ this_source = @component.strip_trailing_whitespace? ? original_source.rstrip : original_source
213
233
 
214
234
  short_identifier = defined?(Rails.root) ? @path.sub("#{Rails.root}/", "") : @path
215
235
  format = self.format || DEFAULT_FORMAT
216
236
  type = ActionView::Template::Types[format]
217
237
 
218
- handler.call(DataWithSource.new(format:, identifier: @path, short_identifier:, type:), this_source)
238
+ handler.call(DataWithSource.new(format:, identifier: @path, short_identifier:, type:), this_source).tap do |compiled|
239
+ CacheDigest.compiled(handler, original_source, compiled)
240
+ end
219
241
  end
220
242
  end
221
243
  end
@@ -85,19 +85,23 @@ module ViewComponent
85
85
  #
86
86
  # In RSpec, `Preview` is appended to `described_class`.
87
87
  def render_preview(name, from: __vc_test_helpers_preview_class, params: {})
88
- previews_controller = __vc_test_helpers_build_controller(Rails.application.config.view_component.previews.controller.constantize)
89
-
90
- # From what I can tell, it's not possible to overwrite all request parameters
91
- # at once, so we set them individually here.
92
- params.each do |k, v|
93
- previews_controller.request.params[k] = v
94
- end
95
-
96
- previews_controller.request.params[:path] = "#{from.preview_name}/#{name}"
88
+ @page = nil
89
+ controller_class = Rails.application.config.view_component.previews.controller.constantize
90
+ request = ActionDispatch::TestRequest.new(vc_test_request.env.dup)
91
+ query_parameters = vc_test_request.query_parameters.deep_dup.merge(params.stringify_keys)
92
+ request.path_parameters = vc_test_request.path_parameters.deep_dup
93
+ request.set_header("action_dispatch.request.query_parameters", query_parameters)
94
+ request.set_header(Rack::QUERY_STRING, query_parameters.to_query)
95
+ previews_controller = __vc_test_helpers_build_controller(controller_class, request: request)
96
+ # Dispatch the preview without replacing the request's URL generation context.
97
+ previews_controller.params = request.parameters.merge(params.stringify_keys).merge(
98
+ "controller" => controller_class.controller_path,
99
+ "action" => "previews",
100
+ "path" => "#{from.preview_name}/#{name}"
101
+ )
97
102
  previews_controller.set_response!(ActionDispatch::Response.new)
98
- result = previews_controller.previews
99
-
100
- @rendered_content = result
103
+ previews_controller.process(:previews)
104
+ @rendered_content = previews_controller.response.body
101
105
 
102
106
  Nokogiri::HTML5.fragment(@rendered_content)
103
107
  end
@@ -149,11 +153,14 @@ module ViewComponent
149
153
  # @param klass [Class<ActionController::Base>] The controller to be used.
150
154
  def with_controller_class(klass)
151
155
  old_controller = defined?(@vc_test_controller) && @vc_test_controller
156
+ old_view_context = defined?(@vc_test_view_context) && @vc_test_view_context
152
157
 
158
+ @vc_test_view_context = nil
153
159
  @vc_test_controller = __vc_test_helpers_build_controller(klass)
154
160
  yield
155
161
  ensure
156
162
  @vc_test_controller = old_controller
163
+ @vc_test_view_context = old_view_context
157
164
  end
158
165
 
159
166
  # Set format of the current request
@@ -211,15 +218,21 @@ module ViewComponent
211
218
  # @param method [String] The request method to set for the current request.
212
219
  # @param protocol [Symbol] The protocol to set for the current request (e.g., `:http` or `:https`).
213
220
  def with_request_url(full_path, host: nil, method: nil, protocol: nil)
214
- old_request_host = vc_test_request.host
221
+ old_request_host = vc_test_request.get_header("HTTP_HOST")
215
222
  old_request_method = vc_test_request.request_method
216
223
  old_request_path_info = vc_test_request.path_info
217
224
  old_request_path_parameters = vc_test_request.path_parameters
218
225
  old_request_query_parameters = vc_test_request.query_parameters
219
226
  old_request_query_string = vc_test_request.query_string
227
+ old_request_fullpath = vc_test_request.fullpath
228
+ old_request_original_fullpath = vc_test_request.original_fullpath
220
229
  old_request_format = vc_test_request.format.symbol
221
230
  old_request_scheme = vc_test_request.scheme
231
+ old_request_protocol = vc_test_request.instance_variable_get(:@protocol)
232
+ old_request_port = vc_test_request.instance_variable_get(:@port)
222
233
  old_controller = defined?(@vc_test_controller) && @vc_test_controller
234
+ old_controller_params = old_controller.params if old_controller
235
+ old_controller_url_options = old_controller.instance_variable_get(:@_url_options) if old_controller
223
236
 
224
237
  path, query = full_path.split("?", 2)
225
238
  vc_test_request.instance_variable_set(:@fullpath, full_path)
@@ -227,21 +240,32 @@ module ViewComponent
227
240
  vc_test_request.host = host if host
228
241
  vc_test_request.request_method = method if method
229
242
  vc_test_request.set_header(Rack::RACK_URL_SCHEME, protocol.to_s) if protocol
243
+ vc_test_request.instance_variable_set(:@protocol, nil)
244
+ vc_test_request.instance_variable_set(:@port, nil)
230
245
  vc_test_request.path_info = path
231
246
  vc_test_request.path_parameters = Rails.application.routes.recognize_path_with_request(vc_test_request, path, {})
232
247
  vc_test_request.set_header("action_dispatch.request.query_parameters",
233
248
  Rack::Utils.parse_nested_query(query).with_indifferent_access)
234
249
  vc_test_request.set_header(Rack::QUERY_STRING, query)
250
+ old_controller.params = nil if old_controller
251
+ old_controller&.instance_variable_set(:@_url_options, nil)
235
252
  yield
236
253
  ensure
237
254
  vc_test_request.host = old_request_host
238
255
  vc_test_request.request_method = old_request_method
239
256
  vc_test_request.set_header(Rack::RACK_URL_SCHEME, old_request_scheme)
257
+ vc_test_request.instance_variable_set(:@protocol, old_request_protocol)
258
+ vc_test_request.instance_variable_set(:@port, old_request_port)
240
259
  vc_test_request.path_info = old_request_path_info
241
260
  vc_test_request.path_parameters = old_request_path_parameters
242
261
  vc_test_request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)
243
262
  vc_test_request.set_header(Rack::QUERY_STRING, old_request_query_string)
263
+ vc_test_request.instance_variable_set(:@fullpath, old_request_fullpath)
264
+ vc_test_request.instance_variable_set(:@original_fullpath, old_request_original_fullpath)
244
265
  vc_test_request.format = old_request_format
266
+ old_controller.params = old_controller_params if old_controller
267
+ @vc_test_controller&.instance_variable_set(:@_url_options, nil)
268
+ old_controller&.instance_variable_set(:@_url_options, old_controller_url_options)
245
269
  @vc_test_controller = old_controller
246
270
  end
247
271
 
@@ -298,8 +322,8 @@ module ViewComponent
298
322
  # Note: We prefix private methods here to prevent collisions in consumer's tests.
299
323
  private
300
324
 
301
- def __vc_test_helpers_build_controller(klass)
302
- klass.new.tap { |c| c.request = vc_test_request }.extend(Rails.application.routes.url_helpers)
325
+ def __vc_test_helpers_build_controller(klass, request: vc_test_request)
326
+ klass.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
303
327
  end
304
328
 
305
329
  def __vc_test_helpers_preview_class
@@ -14,6 +14,34 @@ module ViewComponent
14
14
  TRANSLATION_EXTENSIONS = %w[yml yaml].freeze
15
15
  private_constant :TRANSLATION_EXTENSIONS
16
16
 
17
+ # Like Rails' translation helper, use a sentinel that survives cache serialization.
18
+ MISSING_TRANSLATION = -(2**61)
19
+ private_constant :MISSING_TRANSLATION
20
+
21
+ def self.symbolic_defaults?(options)
22
+ default = options[:default]
23
+ default.is_a?(Symbol) || (default.is_a?(Array) && default.any? { |value| value.is_a?(Symbol) })
24
+ end
25
+
26
+ def self.translate_with_defaults(translator, key, options)
27
+ defaults = options[:default].is_a?(Array) ? options[:default].compact : [options[:default]]
28
+ options = options.except(:default)
29
+
30
+ translated = translator.translate(key, **options, default: MISSING_TRANSLATION)
31
+ return translated unless translated == MISSING_TRANSLATION
32
+
33
+ defaults.each do |default|
34
+ translated = if default.is_a?(Symbol)
35
+ translator.translate(default, **options, default: MISSING_TRANSLATION)
36
+ else
37
+ translator.translate(key, **options, default: [default, MISSING_TRANSLATION])
38
+ end
39
+ return translated unless translated == MISSING_TRANSLATION
40
+ end
41
+
42
+ translator.translate(key, **options)
43
+ end
44
+
17
45
  included do
18
46
  class_attribute :__vc_i18n_backend, instance_writer: false, instance_predicate: false
19
47
  end
@@ -30,7 +58,7 @@ module ViewComponent
30
58
  # can inherit translations from its parent and is able to overwrite them.
31
59
  translation_files = ancestors.reverse_each.with_object([]) do |ancestor, files|
32
60
  if ancestor.is_a?(Class) && ancestor < ViewComponent::Base
33
- files.concat(ancestor.sidecar_files(TRANSLATION_EXTENSIONS))
61
+ files.concat(ancestor.__vc_sidecar_files(TRANSLATION_EXTENSIONS))
34
62
  end
35
63
  end
36
64
 
@@ -53,9 +81,13 @@ module ViewComponent
53
81
 
54
82
  def translate(key = nil, **options)
55
83
  return key.map { |k| translate(k, **options) } if key.is_a?(Array)
84
+ symbolic_defaults = Translatable.symbolic_defaults?(options)
85
+ return ::I18n.translate(key, **options) if key.nil? && !symbolic_defaults
56
86
 
57
87
  __vc_ensure_compiled
58
88
 
89
+ return Translatable.translate_with_defaults(self, key, options) if symbolic_defaults
90
+
59
91
  locale = options.delete(:locale) || ::I18n.locale
60
92
  key = __vc_i18n_key(key, options.delete(:scope))
61
93
 
@@ -99,6 +131,8 @@ module ViewComponent
99
131
 
100
132
  return @view_context.translate(key, **options) unless __vc_i18n_backend
101
133
  return key.map { |k| translate(k, **options) } if key.is_a?(Array)
134
+ return Translatable.translate_with_defaults(self, key, options) if Translatable.symbolic_defaults?(options)
135
+ return @view_context.translate(key, **options) if key.nil?
102
136
 
103
137
  locale = options.delete(:locale) || ::I18n.locale
104
138
  key = self.class.__vc_i18n_key(key, options.delete(:scope))
@@ -3,7 +3,7 @@
3
3
  module ViewComponent
4
4
  module VERSION
5
5
  MAJOR = 4
6
- MINOR = 17
6
+ MINOR = 24
7
7
  PATCH = 0
8
8
  PRE = nil
9
9