Class: Puppet::Pops::Lookup::Invocation Private

Inherits:
Object
  • Object
show all
Defined in:
lib/puppet/pops/lookup/invocation.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Direct Known Subclasses

ScopeLookupCollectingInvocation

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, override_values = EMPTY_HASH, default_values = EMPTY_HASH, explainer = nil, adapter_class = LookupAdapter) ⇒ Invocation

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Creates a context object for a lookup invocation. The object contains the current scope, overrides, and default values and may optionally contain an ExplanationAcceptor instance that will receive book-keeping information about the progress of the lookup.

If the explain argument is a boolean, then false means that no explanation is needed and true means that the default explanation acceptor should be used. The explain argument may also be an instance of the ‘ExplanationAcceptor` class.

Parameters:

  • scope (Puppet::Parser::Scope) —

    The scope to use for the lookup

  • override_values (Hash<String,Object>|nil) (defaults to: EMPTY_HASH) —

    A map to use as override. Values found here are returned immediately (no merge)

  • default_values (Hash<String,Object>) (defaults to: EMPTY_HASH) —

    A map to use as the last resort (but before default)

  • explainer (boolean, Explanainer) (defaults to: nil) —

    An boolean true to use the default explanation acceptor or an explainer instance that will receive information about the lookup



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 25

def initialize(scope, override_values = EMPTY_HASH, default_values = EMPTY_HASH, explainer = nil, adapter_class = LookupAdapter)
  @scope = scope
  @override_values = override_values
  @default_values = default_values

  parent_invocation = self.class.current
  if parent_invocation.nil?
    @name_stack = []
    @adapter_class = adapter_class
    unless explainer.is_a?(Explainer)
      explainer = explainer == true ? Explainer.new : nil
    end
    explainer = DebugExplainer.new(explainer) if Puppet[:debug] && !explainer.is_a?(DebugExplainer)
  else
    @name_stack = parent_invocation.name_stack
    @adapter_class = parent_invocation.adapter_class
    set_global_only if parent_invocation.global_only?
    povr = parent_invocation.hiera_v3_location_overrides
    set_hiera_v3_location_overrides(povr) unless povr.empty?
    explainer = explainer == false ? nil : parent_invocation.explainer
  end
  @explainer = explainer
end

Instance Attribute Details

#adapter_class ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



7
8
9
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 7

def adapter_class
  @adapter_class
end

#default_values ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



7
8
9
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 7

def default_values
  @default_values
end

#explainer ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



7
8
9
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 7

def explainer
  @explainer
end

#module_name ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



7
8
9
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 7

def module_name
  @module_name
end

#override_values ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



7
8
9
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 7

def override_values
  @override_values
end

#scope ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



7
8
9
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 7

def scope
  @scope
end

#top_key ⇒ Object (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



7
8
9
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 7

def top_key
  @top_key
end

Class Method Details

.current ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



9
10
11
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 9

def self.current
  @current
end

Instance Method Details

#check(name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 65

def check(name)
  if @name_stack.include?(name)
    raise Puppet::DataBinding::RecursiveLookupError, "Recursive lookup detected in [#{@name_stack.join(', ')}]"
  end
  return unless block_given?

  @name_stack.push(name)
  begin
    yield
  rescue Puppet::DataBinding::LookupError
    raise
  rescue Puppet::Error => detail
    raise Puppet::DataBinding::LookupError.new(detail.message, nil, nil, nil, detail)
  ensure
    @name_stack.pop
  end
end

#emit_debug_info(preamble) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



83
84
85
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 83

def emit_debug_info(preamble)
  @explainer.emit_debug_info(preamble) if @explainer.is_a?(DebugExplainer)
end

#explain_options? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


127
128
129
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 127

def explain_options?
  @explainer.nil? ? false : @explainer.explain_options?
end

#global_hiera_config_path ⇒ Pathname

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns the full path of the hiera.yaml config file.

Returns:

  • (Pathname) —

    the full path of the hiera.yaml config file



192
193
194
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 192

def global_hiera_config_path
  lookup_adapter.global_hiera_config_path
end

#global_only? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


180
181
182
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 180

def global_only?
  lookup_adapter.global_only? || (instance_variable_defined?(:@global_only) ? @global_only : false)
end

#hiera_v3_location_overrides ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



201
202
203
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 201

def hiera_v3_location_overrides
  instance_variable_defined?(:@hiera_v3_location_overrides) ? @hiera_v3_location_overrides : EMPTY_ARRAY
end

#lookup(key, module_name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 49

def lookup(key, module_name)
  @top_key = key
  @module_name = module_name
  save_current = self.class.current
  if save_current.equal?(self)
    yield
  else
    begin
      self.class.instance_variable_set(:@current, self)
      yield
    ensure
      self.class.instance_variable_set(:@current, save_current)
    end
  end
end

#lookup_adapter ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



87
88
89
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 87

def lookup_adapter
  @adapter ||= @adapter_class.adapt(scope.compiler)
end

#only_explain_options? ⇒ Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean) 


123
124
125
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 123

def only_explain_options?
  @explainer.nil? ? false : @explainer.only_explain_options?
end

#remember_scope_lookup(*lookup_result) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

This method is overridden by the special Invocation used while resolving interpolations in a Hiera configuration file (hiera.yaml) where it’s used for collecting and remembering the current values that the configuration was based on



96
97
98
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 96

def remember_scope_lookup(*lookup_result)
  # Does nothing by default
end

#report_found(key, value) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



141
142
143
144
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 141

def report_found(key, value)
  @explainer.accept_found(key, value) unless @explainer.nil?
  value
end

#report_found_in_defaults(key, value) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



136
137
138
139
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 136

def report_found_in_defaults(key, value)
  @explainer.accept_found_in_defaults(key, value) unless @explainer.nil?
  value
end

#report_found_in_overrides(key, value) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



131
132
133
134
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 131

def report_found_in_overrides(key, value)
  @explainer.accept_found_in_overrides(key, value) unless @explainer.nil?
  value
end

#report_location_not_found ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



162
163
164
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 162

def report_location_not_found
  @explainer.accept_location_not_found unless @explainer.nil?
end

#report_merge_source(merge_source) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



146
147
148
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 146

def report_merge_source(merge_source)
  @explainer.accept_merge_source(merge_source) unless @explainer.nil?
end

#report_module_not_found(module_name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



166
167
168
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 166

def report_module_not_found(module_name)
  @explainer.accept_module_not_found(module_name) unless @explainer.nil?
end

#report_module_provider_not_found(module_name) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



170
171
172
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 170

def report_module_provider_not_found(module_name)
  @explainer.accept_module_provider_not_found(module_name) unless @explainer.nil?
end

#report_not_found(key) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



158
159
160
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 158

def report_not_found(key)
  @explainer.accept_not_found(key) unless @explainer.nil?
end

#report_result(value) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Report the result of a merge or fully resolved interpolated string

Parameters:

  • value (Object) —

    The result to report

Returns:

  • (Object) —

    the given value



153
154
155
156
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 153

def report_result(value)
  @explainer.accept_result(value) unless @explainer.nil?
  value
end

#report_text(&block) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future. 



174
175
176
177
178
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 174

def report_text(&block)
  unless @explainer.nil?
    @explainer.accept_text(block.call)
  end
end

#set_global_only ⇒ Invocation

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Instructs the lookup framework to only perform lookups in the global layer

Returns:



186
187
188
189
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 186

def set_global_only
  @global_only = true
  self
end

#set_hiera_v3_location_overrides(overrides) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Overrides passed from hiera_xxx functions down to V3DataHashFunctionProvider



197
198
199
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 197

def set_hiera_v3_location_overrides(overrides)
  @hiera_v3_location_overrides = [overrides].flatten unless overrides.nil?
end

#with(qualifier_type, qualifier) ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

The qualifier_type can be one of: :global - qualifier is the data binding terminus name :data_provider - qualifier a DataProvider instance :path - qualifier is a ResolvedPath instance :merge - qualifier is a MergeStrategy instance :interpolation - qualifier is the unresolved interpolation expression :meta - qualifier is the module name :data - qualifier is the key

Parameters:

  • qualifier (Object) —

    A branch, a provider, or a path



110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/puppet/pops/lookup/invocation.rb', line 110

def with(qualifier_type, qualifier)
  if explainer.nil?
    yield
  else
    @explainer.push(qualifier_type, qualifier)
    begin
      yield
    ensure
      @explainer.pop
    end
  end
end