view_component 4.19.0 → 4.23.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.
- checksums.yaml +4 -4
- data/app/views/test_mailer/test_multipart_email.html.erb +1 -0
- data/app/views/test_mailer/test_multipart_email.text.erb +1 -0
- data/docs/CHANGELOG.md +180 -0
- data/lib/generators/view_component/abstract_generator.rb +24 -4
- data/lib/generators/view_component/component/component_generator.rb +8 -6
- data/lib/generators/view_component/component/templates/component.rb.tt +1 -1
- data/lib/generators/view_component/erb/erb_generator.rb +2 -2
- data/lib/generators/view_component/haml/haml_generator.rb +1 -1
- data/lib/generators/view_component/locale/locale_generator.rb +2 -6
- data/lib/generators/view_component/preview/preview_generator.rb +9 -6
- data/lib/generators/view_component/preview/templates/component_preview.rb.tt +2 -2
- data/lib/generators/view_component/rspec/rspec_generator.rb +1 -1
- data/lib/generators/view_component/rspec/templates/component_spec.rb.tt +1 -1
- data/lib/generators/view_component/slim/slim_generator.rb +1 -1
- data/lib/generators/view_component/stimulus/stimulus_generator.rb +3 -7
- data/lib/generators/view_component/test_unit/templates/component_test.rb.tt +2 -2
- data/lib/generators/view_component/test_unit/test_unit_generator.rb +8 -7
- data/lib/view_component/base.rb +127 -101
- data/lib/view_component/cache_digest/dependency_tracking.rb +27 -11
- data/lib/view_component/cache_digest/digestor_lookup.rb +47 -1
- data/lib/view_component/cache_digest/resolver.rb +146 -52
- data/lib/view_component/cache_digest.rb +346 -56
- data/lib/view_component/cacheable.rb +16 -18
- data/lib/view_component/collection.rb +4 -9
- data/lib/view_component/compile_cache.rb +62 -2
- data/lib/view_component/compiler.rb +76 -13
- data/lib/view_component/config.rb +114 -8
- data/lib/view_component/engine.rb +10 -6
- data/lib/view_component/errors.rb +16 -0
- data/lib/view_component/request_details.rb +5 -10
- data/lib/view_component/slot.rb +12 -0
- data/lib/view_component/slotable.rb +32 -8
- data/lib/view_component/template.rb +33 -15
- data/lib/view_component/test_helpers.rb +40 -16
- data/lib/view_component/translatable.rb +35 -1
- data/lib/view_component/version.rb +1 -1
- metadata +17 -1
|
@@ -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
|
-
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
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
|
-
|
|
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.
|
|
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
|
-
vc_test_request.
|
|
254
|
+
vc_test_request.set_header("HTTP_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 =
|
|
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.
|
|
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))
|
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.
|
|
4
|
+
version: 4.23.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
|