view_component 4.19.0 → 4.21.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 (38) 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 +144 -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 +127 -101
  20. data/lib/view_component/cache_digest/dependency_tracking.rb +9 -1
  21. data/lib/view_component/cache_digest/digestor_lookup.rb +3 -1
  22. data/lib/view_component/cache_digest/resolver.rb +131 -52
  23. data/lib/view_component/cache_digest.rb +286 -48
  24. data/lib/view_component/cacheable.rb +16 -18
  25. data/lib/view_component/collection.rb +4 -9
  26. data/lib/view_component/compile_cache.rb +59 -2
  27. data/lib/view_component/compiler.rb +76 -13
  28. data/lib/view_component/config.rb +114 -8
  29. data/lib/view_component/engine.rb +10 -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 +12 -0
  33. data/lib/view_component/slotable.rb +32 -8
  34. data/lib/view_component/template.rb +33 -15
  35. data/lib/view_component/test_helpers.rb +38 -16
  36. data/lib/view_component/translatable.rb +35 -1
  37. data/lib/view_component/version.rb +1 -1
  38. metadata +17 -1
@@ -85,19 +85,21 @@ 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.except(*params.keys.map(&:to_sym)).merge(
93
+ controller: controller_class.controller_path,
94
+ action: "previews",
95
+ path: "#{from.preview_name}/#{name}"
96
+ )
97
+ request.set_header("action_dispatch.request.query_parameters", query_parameters)
98
+ request.set_header(Rack::QUERY_STRING, query_parameters.to_query)
99
+ previews_controller = __vc_test_helpers_build_controller(controller_class, request: request)
97
100
  previews_controller.set_response!(ActionDispatch::Response.new)
98
- result = previews_controller.previews
99
-
100
- @rendered_content = result
101
+ previews_controller.process(:previews)
102
+ @rendered_content = previews_controller.response.body
101
103
 
102
104
  Nokogiri::HTML5.fragment(@rendered_content)
103
105
  end
@@ -149,11 +151,14 @@ module ViewComponent
149
151
  # @param klass [Class<ActionController::Base>] The controller to be used.
150
152
  def with_controller_class(klass)
151
153
  old_controller = defined?(@vc_test_controller) && @vc_test_controller
154
+ old_view_context = defined?(@vc_test_view_context) && @vc_test_view_context
152
155
 
156
+ @vc_test_view_context = nil
153
157
  @vc_test_controller = __vc_test_helpers_build_controller(klass)
154
158
  yield
155
159
  ensure
156
160
  @vc_test_controller = old_controller
161
+ @vc_test_view_context = old_view_context
157
162
  end
158
163
 
159
164
  # Set format of the current request
@@ -211,15 +216,21 @@ module ViewComponent
211
216
  # @param method [String] The request method to set for the current request.
212
217
  # @param protocol [Symbol] The protocol to set for the current request (e.g., `:http` or `:https`).
213
218
  def with_request_url(full_path, host: nil, method: nil, protocol: nil)
214
- old_request_host = vc_test_request.host
219
+ old_request_host = vc_test_request.get_header("HTTP_HOST")
215
220
  old_request_method = vc_test_request.request_method
216
221
  old_request_path_info = vc_test_request.path_info
217
222
  old_request_path_parameters = vc_test_request.path_parameters
218
223
  old_request_query_parameters = vc_test_request.query_parameters
219
224
  old_request_query_string = vc_test_request.query_string
225
+ old_request_fullpath = vc_test_request.fullpath
226
+ old_request_original_fullpath = vc_test_request.original_fullpath
220
227
  old_request_format = vc_test_request.format.symbol
221
228
  old_request_scheme = vc_test_request.scheme
229
+ old_request_protocol = vc_test_request.instance_variable_get(:@protocol)
230
+ old_request_port = vc_test_request.instance_variable_get(:@port)
222
231
  old_controller = defined?(@vc_test_controller) && @vc_test_controller
232
+ old_controller_params = old_controller.params if old_controller
233
+ old_controller_url_options = old_controller.instance_variable_get(:@_url_options) if old_controller
223
234
 
224
235
  path, query = full_path.split("?", 2)
225
236
  vc_test_request.instance_variable_set(:@fullpath, full_path)
@@ -227,21 +238,32 @@ module ViewComponent
227
238
  vc_test_request.host = host if host
228
239
  vc_test_request.request_method = method if method
229
240
  vc_test_request.set_header(Rack::RACK_URL_SCHEME, protocol.to_s) if protocol
241
+ vc_test_request.instance_variable_set(:@protocol, nil)
242
+ vc_test_request.instance_variable_set(:@port, nil)
230
243
  vc_test_request.path_info = path
231
244
  vc_test_request.path_parameters = Rails.application.routes.recognize_path_with_request(vc_test_request, path, {})
232
245
  vc_test_request.set_header("action_dispatch.request.query_parameters",
233
246
  Rack::Utils.parse_nested_query(query).with_indifferent_access)
234
247
  vc_test_request.set_header(Rack::QUERY_STRING, query)
248
+ old_controller.params = nil if old_controller
249
+ old_controller&.instance_variable_set(:@_url_options, nil)
235
250
  yield
236
251
  ensure
237
- vc_test_request.host = old_request_host
252
+ vc_test_request.set_header("HTTP_HOST", old_request_host)
238
253
  vc_test_request.request_method = old_request_method
239
254
  vc_test_request.set_header(Rack::RACK_URL_SCHEME, old_request_scheme)
255
+ vc_test_request.instance_variable_set(:@protocol, old_request_protocol)
256
+ vc_test_request.instance_variable_set(:@port, old_request_port)
240
257
  vc_test_request.path_info = old_request_path_info
241
258
  vc_test_request.path_parameters = old_request_path_parameters
242
259
  vc_test_request.set_header("action_dispatch.request.query_parameters", old_request_query_parameters)
243
260
  vc_test_request.set_header(Rack::QUERY_STRING, old_request_query_string)
261
+ vc_test_request.instance_variable_set(:@fullpath, old_request_fullpath)
262
+ vc_test_request.instance_variable_set(:@original_fullpath, old_request_original_fullpath)
244
263
  vc_test_request.format = old_request_format
264
+ old_controller.params = old_controller_params if old_controller
265
+ @vc_test_controller&.instance_variable_set(:@_url_options, nil)
266
+ old_controller&.instance_variable_set(:@_url_options, old_controller_url_options)
245
267
  @vc_test_controller = old_controller
246
268
  end
247
269
 
@@ -298,8 +320,8 @@ module ViewComponent
298
320
  # Note: We prefix private methods here to prevent collisions in consumer's tests.
299
321
  private
300
322
 
301
- def __vc_test_helpers_build_controller(klass)
302
- klass.new.tap { |c| c.request = vc_test_request }.extend(Rails.application.routes.url_helpers)
323
+ def __vc_test_helpers_build_controller(klass, request: vc_test_request)
324
+ klass.new.tap { |c| c.request = request }.extend(Rails.application.routes.url_helpers)
303
325
  end
304
326
 
305
327
  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 = 19
6
+ MINOR = 21
7
7
  PATCH = 0
8
8
  PRE = nil
9
9
 
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: view_component
3
3
  version: !ruby/object:Gem::Version
4
- version: 4.19.0
4
+ version: 4.21.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - ViewComponent Team
@@ -37,6 +37,20 @@ dependencies:
37
37
  - - ">="
38
38
  - !ruby/object:Gem::Version
39
39
  version: 7.1.0
40
+ - !ruby/object:Gem::Dependency
41
+ name: prism
42
+ requirement: !ruby/object:Gem::Requirement
43
+ requirements:
44
+ - - ">="
45
+ - !ruby/object:Gem::Version
46
+ version: '1.0'
47
+ type: :runtime
48
+ prerelease: false
49
+ version_requirements: !ruby/object:Gem::Requirement
50
+ requirements:
51
+ - - ">="
52
+ - !ruby/object:Gem::Version
53
+ version: '1.0'
40
54
  executables: []
41
55
  extensions: []
42
56
  extra_rdoc_files: []
@@ -48,6 +62,8 @@ files:
48
62
  - app/controllers/view_components_system_test_controller.rb
49
63
  - app/views/test_mailer/test_asset_email.html.erb
50
64
  - app/views/test_mailer/test_email.html.erb
65
+ - app/views/test_mailer/test_multipart_email.html.erb
66
+ - app/views/test_mailer/test_multipart_email.text.erb
51
67
  - app/views/test_mailer/test_url_email.html.erb
52
68
  - app/views/view_components/index.html.erb
53
69
  - app/views/view_components/preview.html.erb