Class: Hocon::Impl::ConfigDelayedMerge
Overview
The issue here is that we want to first merge our stack of config files, and then we want to evaluate substitutions. But if two substitutions both expand to an object, we might need to merge those two objects. Thus, we can’t ever “override” a substitution when we do a merge; instead we have to save the stack of values that should be merged, and resolve the merge when we evaluate substitutions.
Constant Summary
collapse
- ConfigImpl =
Hocon::Impl::ConfigImpl
- ResolveResult =
Hocon::Impl::ResolveResult
AbstractConfigValue::ConfigBugOrBrokenError, AbstractConfigValue::ConfigImplUtil, AbstractConfigValue::ResolveStatus
Instance Attribute Summary collapse
#origin
Class Method Summary
collapse
-
.make_replacement(context, stack, skipping) ⇒ Object
static method also used by ConfigDelayedMergeObject; end may be null.
-
.render_value_to_sb_from_stack(stack, sb, indent, at_root, at_key, options) ⇒ Object
static method also used by ConfigDelayedMergeObject.
-
.resolve_substitutions(replaceable, stack, context, source) ⇒ Object
-
.stack_ignores_fallbacks?(stack) ⇒ Boolean
static utility shared with ConfigDelayedMergeObject.
Instance Method Summary
collapse
#at_key, #at_key_with_origin, #at_path, #at_path_with_origin, #construct_delayed_merge, #delay_merge, has_descendant_in_list?, indent, #inspect, #merged_stack_with_non_object, #merged_stack_with_object, #merged_stack_with_the_unmergeable, #render, #render_value_to_sb, replace_child_in_list, #require_not_ignoring_fallbacks, #to_fallback_value, #to_s, #transform_to_string, #with_fallback, #with_fallbacks_ignored, #with_origin
#at_key, #at_path, #origin, #render, #with_fallback, #with_origin
#with_fallback
Constructor Details
Returns a new instance of ConfigDelayedMerge.
Instance Attribute Details
#stack ⇒ Object
Returns the value of attribute stack.
40
41
42
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 40
def stack
@stack
end
|
Class Method Details
.make_replacement(context, stack, skipping) ⇒ Object
static method also used by ConfigDelayedMergeObject; end may be null
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 159
def self.make_replacement(context, stack, skipping)
sub_stack = stack.slice(skipping..stack.size)
if sub_stack.empty?
if ConfigImpl.trace_substitution_enabled
ConfigImpl.trace("Nothing else in the merge stack, replacing with null", context.depth)
return nil
end
else
merged = nil
sub_stack.each do |v|
if merged.nil?
merged = v
else
merged = merged.with_fallback(v)
end
end
merged
end
end
|
.render_value_to_sb_from_stack(stack, sb, indent, at_root, at_key, options) ⇒ Object
static method also used by ConfigDelayedMergeObject.
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
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 256
def self.render_value_to_sb_from_stack(stack, sb, indent, at_root, at_key, options)
= options.
if
sb << "# unresolved merge of #{stack.size} values follows (\n"
if at_key.nil?
self.indent(sb, indent, options)
sb << "# this unresolved merge will not be parseable because it's at the root of the object\n"
self.indent(sb, indent, options)
sb << "# the HOCON format has no way to list multiple root objects in a single file\n"
end
end
reversed = stack.reverse
i = 0
reversed.each do |v|
if
self.indent(sb, indent, options)
if !at_key.nil?
rendered_key = Hocon::Impl::ConfigImplUtil.render_json_string(at_key)
sb << "# unmerged value #{i} for key #{rendered_key}"
else
sb << "# unmerged value #{i} from "
end
i += 1
sb << v.origin.description
sb << "\n"
v.origin..each do ||
self.indent(sb, indent, options)
sb << "# "
sb <<
sb << "\n"
end
end
Hocon::Impl::AbstractConfigValue.indent(sb, indent, options)
if !at_key.nil?
sb << Hocon::Impl::ConfigImplUtil.render_json_string(at_key)
if options.formatted
sb << ": "
else
sb << ":"
end
end
v.render_value_to_sb(sb, indent, at_root, options)
sb << ","
if options.formatted
sb.append "\n"
end
end
sb.pos = sb.pos - 1
if options.formatted
sb.pos = sb.pos - 1
sb << "\n"
end
if
self.indent(sb, indent, options)
sb << "# ) end of unresolved merge\n"
end
end
|
.resolve_substitutions(replaceable, stack, context, source) ⇒ Object
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
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 57
def self.resolve_substitutions(replaceable, stack, context, source)
if ConfigImpl.trace_substitution_enabled
ConfigImpl.trace("delayed merge stack has #{stack.size} items:", context.depth)
count = 0
stack.each do |v|
ConfigImpl.trace("#{count}: #{v}", context.depth)
count += 1
end
end
new_context = context
count = 0
merged = nil
stack.each do |stack_end|
if stack_end.is_a?(Hocon::Impl::ReplaceableMergeStack)
raise ConfigBugOrBrokenError, "A delayed merge should not contain another one: #{replaceable}"
elsif stack_end.is_a?(Hocon::Impl::Unmergeable)
remainder = replaceable.make_replacement(context, count + 1)
if ConfigImpl.trace_substitution_enabled
ConfigImpl.trace("remainder portion: #{remainder}", new_context.depth)
end
if ConfigImpl.trace_substitution_enabled
ConfigImpl.trace("building sourceForEnd", new_context.depth)
end
source_for_end = source.replace_within_current_parent(replaceable, remainder)
if ConfigImpl.trace_substitution_enabled
ConfigImpl.trace(" sourceForEnd before reset parents but after replace: #{source_for_end}", new_context.depth)
end
source_for_end = source_for_end.reset_parents
else
if ConfigImpl.trace_substitution_enabled
ConfigImpl.trace("will resolve end against the original source with parent pushed",
new_context.depth)
end
source_for_end = source.push_parent(replaceable)
end
if ConfigImpl.trace_substitution_enabled
ConfigImpl.trace("sourceForEnd =#{source_for_end}", new_context.depth)
end
if ConfigImpl.trace_substitution_enabled
ConfigImpl.trace("Resolving highest-priority item in delayed merge #{stack_end}" +
" against #{source_for_end} endWasRemoved=#{(source != source_for_end)}")
end
result = new_context.resolve(stack_end, source_for_end)
resolved_end = result.value
new_context = result.context
if ! resolved_end.nil?
if merged.nil?
merged = resolved_end
else
if ConfigImpl.trace_substitution_enabled
ConfigImpl.trace("merging #{merged} with fallback #{resolved_end}",
new_context.depth + 1)
end
merged = merged.with_fallback(resolved_end)
end
end
count += 1
if ConfigImpl.trace_substitution_enabled
ConfigImpl.trace("stack merged, yielding: #{merged}",
new_context.depth)
end
end
ResolveResult.make(new_context, merged)
end
|
.stack_ignores_fallbacks?(stack) ⇒ Boolean
static utility shared with ConfigDelayedMergeObject
204
205
206
207
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 204
def self.stack_ignores_fallbacks?(stack)
last = stack[-1]
last.ignores_fallbacks?
end
|
Instance Method Details
#==(other) ⇒ Object
237
238
239
240
241
242
243
244
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 237
def ==(other)
if other.is_a? Hocon::Impl::ConfigDelayedMerge
can_equal(other) && (@stack == other.stack || @stack.equal?(other.stack))
else
false
end
end
|
#can_equal(other) ⇒ Object
233
234
235
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 233
def can_equal(other)
other.is_a? Hocon::Impl::ConfigDelayedMerge
end
|
#has_descendant?(descendant) ⇒ Boolean
#hash ⇒ Object
246
247
248
249
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 246
def hash
@stack.hash
end
|
#ignores_fallbacks? ⇒ Boolean
209
210
211
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 209
def ignores_fallbacks?
self.class.stack_ignores_fallbacks?(stack)
end
|
#make_replacement(context, skipping) ⇒ Object
154
155
156
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 154
def make_replacement(context, skipping)
self.class.make_replacement(context, @stack, skipping)
end
|
#merged_with_non_object(fallback) ⇒ Object
225
226
227
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 225
def merged_with_non_object(fallback)
merged_stack_with_non_object(stack, fallback)
end
|
#merged_with_object(fallback) ⇒ Object
221
222
223
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 221
def merged_with_object(fallback)
merged_stack_with_object(stack, fallback)
end
|
#merged_with_the_unmergeable(fallback) ⇒ Object
217
218
219
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 217
def merged_with_the_unmergeable(fallback)
merged_stack_with_the_unmergeable(stack, fallback)
end
|
#new_copy(new_origin) ⇒ Object
213
214
215
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 213
def new_copy(new_origin)
self.class.new(new_origin, stack)
end
|
#relativized(prefix) ⇒ Object
198
199
200
201
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 198
def relativized(prefix)
new_stack = stack.map { |o| o.relativized(prefix) }
self.class.new(origin, new_stack)
end
|
#render_to_sb(sb, indent, at_root, at_key, options) ⇒ Object
251
252
253
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 251
def render_to_sb(sb, indent, at_root, at_key, options)
self.class.render_value_to_sb_from_stack(stack, sb, indent, at_root, at_key, options)
end
|
#replace_child(child, replacement) ⇒ Object
185
186
187
188
189
190
191
192
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 185
def replace_child(child, replacement)
new_stack = replace_child_in_list(stack, child, replacement)
if new_stack.nil?
nil
else
self.class.new(origin, new_stack)
end
end
|
#resolve_substitutions(context, source) ⇒ Object
53
54
55
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 53
def resolve_substitutions(context, source)
self.class.resolve_substitutions(self, stack, context, source)
end
|
#unmerged_values ⇒ Object
229
230
231
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 229
def unmerged_values
stack
end
|
#unwrapped ⇒ Object
48
49
50
51
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 48
def unwrapped
error_message = "called unwrapped() on value with unresolved substitutions, need to Config#resolve() first, see API docs"
raise Hocon::ConfigError::ConfigNotResolvedError.new(error_message, nil)
end
|
#value_type ⇒ Object
43
44
45
46
|
# File 'lib/hocon/impl/config_delayed_merge.rb', line 43
def value_type
error_message = "called value_type() on value with unresolved substitutions, need to Config#resolve() first, see API docs"
raise Hocon::ConfigError::ConfigNotResolvedError.new(error_message, nil)
end
|