Class: Puppet::Parser::Scope

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Resource::TypeCollectionHelper, Util::Errors, Util::MethodHelper
Defined in:
lib/puppet/parser/scope.rb

Overview

This class is part of the internal parser/evaluator/compiler functionality of Puppet. It is passed between the various classes that participate in evaluation. None of its methods are API except those that are clearly marked as such.

API:

  • public

Defined Under Namespace

Classes: Ephemeral, LocalScope, MatchScope

Constant Summary collapse

AST =

API:

  • public

Puppet::Parser::AST
BUILT_IN_VARS =

Variables that always exist with nil value even if not set

API:

  • public

['module_name'.freeze, 'caller_module_name'.freeze].freeze
RESERVED_VARIABLE_NAMES =

API:

  • public

['trusted', 'facts'].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods included from Util::Errors

#adderrorcontext, #devfail, #error_context, #exceptwrap, #fail

Methods included from Resource::TypeCollectionHelper

#known_resource_types

Methods included from Util::MethodHelper

#requiredopts, #set_options, #symbolize_options

Constructor Details

#initialize(compiler, options = {}) ⇒ Scope

Initialize our new scope. Defaults to having no parent.

Raises:

API:

  • public



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
 
# File 'lib/puppet/parser/scope.rb', line 288

def initialize(compiler, options = {})
  if compiler.is_a? Puppet::Parser::Compiler
    self.compiler = compiler
  else
    raise Puppet::DevError, "you must pass a compiler instance to a new scope object"
  end

  if n = options.delete(:namespace)
    @namespaces = [n]
  else
    @namespaces = [""]
  end

  raise Puppet::DevError, "compiler passed in options" if options.include? :compiler
  set_options(options)

  extend_with_functions_module

  # The symbol table for this scope.  This is where we store variables.
  #    @symtable = Ephemeral.new(nil, true)
  @symtable = LocalScope.new(nil)

  @ephemeral = [ MatchScope.new(@symtable, nil) ]

  # All of the defaults set for types.  It's a hash of hashes,
  # with the first key being the type, then the second key being
  # the parameter.
  @defaults = Hash.new { |dhash,type|
    dhash[type] = {}
  }

  # The table for storing class singletons.  This will only actually
  # be used by top scopes and node scopes.
  @class_scopes = {}

  @enable_immutable_data = Puppet[:immutable_node_data]
end

Dynamic Method Handling

This class handles dynamic methods through the method_missing method

#method_missing(method, *args, &block) ⇒ Object

API:

  • public



838
839
840
841
842
843
844
845
846
847
848
849
850
 
# File 'lib/puppet/parser/scope.rb', line 838

def method_missing(method, *args, &block)
  method.to_s =~ /^function_(.*)$/
  name = $1
  super unless name
  super unless Puppet::Parser::Functions.function(name)
  # In odd circumstances, this might not end up defined by the previous
  # method, so we might as well be certain.
  if respond_to? method
    send(method, *args)
  else
    raise Puppet::DevError, "Function #{name} not defined despite being loaded!"
  end
end

Instance Attribute Details

#compiler ⇒ Object

API:

  • public



32
33
34
 
# File 'lib/puppet/parser/scope.rb', line 32

def compiler
  @compiler
end

#defaults ⇒ Object (readonly)

Hash of hashes of default values per type name

API:

  • public



37
38
39
 
# File 'lib/puppet/parser/scope.rb', line 37

def defaults
  @defaults
end

#namespaces ⇒ Object (readonly)

API:

  • public



34
35
36
 
# File 'lib/puppet/parser/scope.rb', line 34

def namespaces
  @namespaces
end

#parent ⇒ Object

API:

  • public



33
34
35
 
# File 'lib/puppet/parser/scope.rb', line 33

def parent
  @parent
end

#resource ⇒ Object

API:

  • public



31
32
33
 
# File 'lib/puppet/parser/scope.rb', line 31

def resource
  @resource
end

#source ⇒ Object

API:

  • public



31
32
33
 
# File 'lib/puppet/parser/scope.rb', line 31

def source
  @source
end

Class Method Details

.number?(value) ⇒ Boolean

Coerce value to a number, or return nil if it isn’t one.

Returns:

API:

  • public



233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
 
# File 'lib/puppet/parser/scope.rb', line 233

def self.number?(value)
  case value
  when Numeric
    value
  when /^-?\d+(:?\.\d+|(:?\.\d+)?e\d+)$/
    value.to_f
  when /^0x[0-9a-f]+$/i
    value.to_i(16)
  when /^0[0-7]+$/
    value.to_i(8)
  when /^-?\d+$/
    value.to_i
  else
    nil
  end
end

.true?(value) ⇒ Boolean

Is the value true? This allows us to control the definition of truth in one place.

Returns:

API:

  • public



221
222
223
224
225
226
227
228
229
230
 
# File 'lib/puppet/parser/scope.rb', line 221

def self.true?(value)
  case value
  when ''
    false
  when :undef
    false
  else
    !!value
  end
end

Instance Method Details

#[](varname, options = {}) ⇒ Object

Retrieves the variable value assigned to the name given as an argument. The name must be a String, and namespace can be qualified with ‘::’. The value is looked up in this scope, its parent scopes, or in a specific visible named scope.

Parameters:

  • the name of the variable (may be a qualified name using ‘(ns’::‘)*varname`

  • (defaults to: {})

    Additional options, not part of api.

Returns:

  • the value assigned to the given varname

See Also:

API:

  • public



452
453
454
 
# File 'lib/puppet/parser/scope.rb', line 452

def [](varname, options={})
  lookupvar(varname, options)
end

#[]=(varname, value, options = {}) ⇒ Object

Sets the variable value of the name given as an argument to the given value. The value is set in the current scope and may shadow a variable with the same name in a visible outer scope. It is illegal to re-assign a variable in the same scope. It is illegal to set a variable in some other scope/namespace than the scope passed to a method.

Parameters:

  • The variable name to which the value is assigned. Must not contain ::

  • The value to assign to the given variable name.

  • (defaults to: {})

    Additional options, not part of api.

API:

  • public



744
745
746
 
# File 'lib/puppet/parser/scope.rb', line 744

def []=(varname, value, options = {})
  setvar(varname, value, options = {})
end

#add_namespace(ns) ⇒ Object

Add to our list of namespaces.

API:

  • public



251
252
253
254
255
256
257
258
 
# File 'lib/puppet/parser/scope.rb', line 251

def add_namespace(ns)
  return false if @namespaces.include?(ns)
  if @namespaces == [""]
    @namespaces = [ns]
  else
    @namespaces << ns
  end
end

#bound?(name) ⇒ Boolean

Returns true if the given name is bound in the current (most nested) scope for assignments.

Returns:

API:

  • public



214
215
216
217
 
# File 'lib/puppet/parser/scope.rb', line 214

def bound?(name)
  # Do not look in ephemeral (match scope), the semantics is to answer if an assignable variable is bound
  effective_symtable(false).bound?(name)
end

#class_scope(klass) ⇒ Object

Return the scope associated with a class. This is just here so that subclasses can set their parent scopes to be the scope of their parent class, and it’s also used when looking up qualified variables.

API:

  • public



340
341
342
343
344
 
# File 'lib/puppet/parser/scope.rb', line 340

def class_scope(klass)
  # They might pass in either the class or class name
  k = klass.respond_to?(:name) ? klass.name : klass
  @class_scopes[k] || (parent && parent.class_scope(k))
end

#class_set(name, scope) ⇒ Object

Store the fact that we’ve evaluated a class, and store a reference to the scope in which it was evaluated, so that we can look it up later.

API:

  • public



328
329
330
331
332
333
334
 
# File 'lib/puppet/parser/scope.rb', line 328

def class_set(name, scope)
  if parent
    parent.class_set(name, scope)
  else
    @class_scopes[name] = scope
  end
end

#define_settings(type, params) ⇒ Object

Set defaults for a type. The typename should already be downcased, so that the syntax is isolated. We don’t do any kind of type-checking here; instead we let the resource do it when the defaults are used.

API:

  • public



625
626
627
628
629
630
631
632
633
634
635
636
637
 
# File 'lib/puppet/parser/scope.rb', line 625

def define_settings(type, params)
  table = @defaults[type]

  # if we got a single param, it'll be in its own array
  params = [params] unless params.is_a?(Array)

  params.each { |param|
    if table.include?(param.name)
      raise Puppet::ParseError.new("Default already defined for #{type} { #{param.name} }; cannot redefine", param.line, param.file)
    end
    table[param.name] = param
  }
end

#effective_symtable(use_ephemeral) ⇒ Object

Return the effective “table” for setting variables. This method returns the first ephemeral “table” that acts as a local scope, or this scope’s symtable. If the parameter use_ephemeral is true, the “top most” ephemeral “table” will be returned (irrespective of it being a match scope or a local scope).

Parameters:

  • whether the top most ephemeral (of any kind) should be used or not

API:

  • public



721
722
723
724
725
726
727
728
729
730
731
 
# File 'lib/puppet/parser/scope.rb', line 721

def effective_symtable(use_ephemeral)
  s = @ephemeral.last
  if use_ephemeral
    return s || @symtable
  else
    while s && !s.is_local_scope?()
      s = s.parent
    end
    s || @symtable
  end
end

#enclosing_scope ⇒ Puppet::Parser::Scope

The enclosing scope (topscope or nodescope) of this scope. The enclosing scopes are produced when a class or define is included at some point. The parent scope of the included class or define becomes the scope in which it was included. The chain of parent scopes is followed until a node scope or the topscope is found

Returns:

  • The scope or nil if there is no enclosing scope

API:

  • public



475
476
477
478
479
480
481
482
483
484
485
 
# File 'lib/puppet/parser/scope.rb', line 475

def enclosing_scope
  if has_enclosing_scope?
    if parent.is_topscope? or parent.is_nodescope?
      parent
    else
      parent.enclosing_scope
    end
  else
    nil
  end
end

#ephemeral_from(match, file = nil, line = nil) ⇒ Object

API:

  • public



806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
 
# File 'lib/puppet/parser/scope.rb', line 806

def ephemeral_from(match, file = nil, line = nil)
  case match
  when Hash
    # Create local scope ephemeral and set all values from hash
    new_ephemeral(true)
    match.each {|k,v| setvar(k, v, :file => file, :line => line, :ephemeral => true) }
    # Must always have an inner match data scope (that starts out as transparent)
    # In 3x slightly wasteful, since a new nested scope is created for a match 
    # (TODO: Fix that problem)
    new_ephemeral(false)
  else
    raise(ArgumentError,"Invalid regex match data. Got a #{match.class}") unless match.is_a?(MatchData)
    # Create a match ephemeral and set values from match data
    new_match_scope(match)
  end
end

#ephemeral_level ⇒ Object

API:

  • public



782
783
784
 
# File 'lib/puppet/parser/scope.rb', line 782

def ephemeral_level
  @ephemeral.size
end

#exist?(name) ⇒ Boolean

Returns true if the variable of the given name is set to any value (including nil)

Returns:

  • if variable exists or not

API:

  • public



189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
 
# File 'lib/puppet/parser/scope.rb', line 189

def exist?(name)
  # Note !! ensure the answer is boolean
  !! if name =~ /^(.*)::(.+)$/
    class_name = $1
    variable_name = $2
    return true if class_name == '' && BUILT_IN_VARS.include?(variable_name)

    # lookup class, but do not care if it is not evaluated since that will result
    # in it not existing anyway. (Tests may run with just scopes and no evaluated classes which
    # will result in class_scope for "" not returning topscope).
    klass = find_hostclass(class_name)
    other_scope = klass.nil? ? nil : class_scope(klass)
    if other_scope.nil?
      class_name == '' ? compiler.topscope.exist?(variable_name) : false
    else
      other_scope.exist?(variable_name)
    end
  else
    next_scope = inherited_scope || enclosing_scope
    effective_symtable(true).include?(name) || next_scope && next_scope.exist?(name) || BUILT_IN_VARS.include?(name)
  end
end

#find_builtin_resource_type(type) ⇒ Object

API:

  • public



829
830
831
 
# File 'lib/puppet/parser/scope.rb', line 829

def find_builtin_resource_type(type)
  Puppet::Type.type(type.to_s.downcase.to_sym)
end

#find_defined_resource_type(type) ⇒ Object

API:

  • public



833
834
835
 
# File 'lib/puppet/parser/scope.rb', line 833

def find_defined_resource_type(type)
  known_resource_types.find_definition(namespaces, type.to_s.downcase)
end

#find_definition(name) ⇒ Object

API:

  • public



264
265
266
 
# File 'lib/puppet/parser/scope.rb', line 264

def find_definition(name)
  known_resource_types.find_definition(namespaces, name)
end

#find_global_scope ⇒ Object

API:

  • public



268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/puppet/parser/scope.rb', line 268

def find_global_scope()
  # walk upwards until first found node_scope or top_scope
  if is_nodescope? || is_topscope?
    self
  else
    next_scope = inherited_scope || enclosing_scope
    if next_scope.nil?
      # this happens when testing, and there is only a single test scope and no link to any
      # other scopes
      self
    else
      next_scope.find_global_scope()
    end
  end
end

#find_hostclass(name, options = {}) ⇒ Object

API:

  • public



260
261
262
 
# File 'lib/puppet/parser/scope.rb', line 260

def find_hostclass(name, options = {})
  known_resource_types.find_hostclass(namespaces, name, options)
end

#find_resource_type(type) ⇒ Object

API:

  • public



823
824
825
826
827
 
# File 'lib/puppet/parser/scope.rb', line 823

def find_resource_type(type)
  # It still works fine without the type == 'class' short-cut, but it is a lot slower.
  return nil if ["class", "node"].include? type.to_s.downcase
  find_builtin_resource_type(type) || find_defined_resource_type(type)
end

#include?(name) ⇒ Boolean

Returns true if the variable of the given name has a non nil value. TODO: This has vague semantics - does the variable exist or not?

use ['name'] to get nil or value, and if nil check with exist?('name')
this include? is only useful because of checking against the boolean value false.

Returns:

API:

  • public



181
182
183
 
# File 'lib/puppet/parser/scope.rb', line 181

def include?(name)
  ! self[name].nil?
end

#inherited_scope ⇒ Puppet::Parser::Scope

The scope of the inherited thing of this scope’s resource. This could either be a node that was inherited or the class.

Returns:

  • The scope or nil if there is not an inherited scope

API:

  • public



460
461
462
463
464
465
466
 
# File 'lib/puppet/parser/scope.rb', line 460

def inherited_scope
  if has_inherited_class?
    qualified_scope(resource.resource_type.parent)
  else
    nil
  end
end

#is_classscope? ⇒ Boolean

Returns:

API:

  • public



487
488
489
 
# File 'lib/puppet/parser/scope.rb', line 487

def is_classscope?
  resource and resource.type == "Class"
end

#is_nodescope? ⇒ Boolean

Returns:

API:

  • public



491
492
493
 
# File 'lib/puppet/parser/scope.rb', line 491

def is_nodescope?
  resource and resource.type == "Node"
end

#is_topscope? ⇒ Boolean

Returns:

API:

  • public



495
496
497
 
# File 'lib/puppet/parser/scope.rb', line 495

def is_topscope?
  compiler and self == compiler.topscope
end

#lookup_as_local_name?(class_name, variable_name) ⇒ Boolean

Handles the special case of looking up fully qualified variable in not yet evaluated top scope This is ok if the lookup request originated in topscope (this happens when evaluating bindings; using the top scope to provide the values for facts.

Parameters:

  • the classname part of a variable name, may be special “”

  • the variable name without the absolute leading ‘::’

Returns:

  • true if the given variable name should be looked up directly in this scope

API:

  • public



529
530
531
532
533
534
535
 
# File 'lib/puppet/parser/scope.rb', line 529

def lookup_as_local_name?(class_name, variable_name)
  # not a local if name has more than one segment
  return nil if variable_name =~ /::/
  # partial only if the class for "" cannot be found
  return nil unless class_name == "" && klass = find_hostclass(class_name) && class_scope(klass).nil?
  is_topscope?
end

#lookup_qualified_variable(class_name, variable_name, position) ⇒ Object

API:

  • public



499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
 
# File 'lib/puppet/parser/scope.rb', line 499

def lookup_qualified_variable(class_name, variable_name, position)
  begin
    if lookup_as_local_name?(class_name, variable_name)
      self[variable_name]
    else
      qualified_scope(class_name).lookupvar(variable_name, position)
    end
  rescue RuntimeError => e
    unless Puppet[:strict_variables]
      # Do not issue warning if strict variables are on, as an error will be raised by variable_not_found
      location = if position[:lineproc]
                   " at #{position[:lineproc].call}"
                 elsif position[:file] && position[:line]
                   " at #{position[:file]}:#{position[:line]}"
                 else
                   ""
                 end
      warning "Could not look up qualified variable '#{class_name}::#{variable_name}'; #{e.message}#{location}"
    end
    variable_not_found("#{class_name}::#{variable_name}", e.message)
  end
end

#lookupdefaults(type) ⇒ Object

Collect all of the defaults set at any higher scopes. This is a different type of lookup because it’s additive – it collects all of the defaults, with defaults in closer scopes overriding those in later scopes.

The lookupdefaults searches in the the order:

* inherited
* contained (recursive)
* self

API:

  • public



357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/puppet/parser/scope.rb', line 357

def lookupdefaults(type)
  values = {}

  # first collect the values from the parents
  if parent
    parent.lookupdefaults(type).each { |var,value|
      values[var] = value
    }
  end

  # then override them with any current values
  # this should probably be done differently
  if @defaults.include?(type)
    @defaults[type].each { |var,value|
      values[var] = value
    }
  end

  values
end

#lookuptype(name) ⇒ Object

Look up a defined type.

API:

  • public



379
380
381
 
# File 'lib/puppet/parser/scope.rb', line 379

def lookuptype(name)
  find_definition(name) || find_hostclass(name)
end

#lookupvar(name, options = {}) ⇒ Object

Lookup a variable within this scope using the Puppet language’s scoping rules. Variables can be qualified using just as in a manifest.

Parameters:

  • the variable name to lookup

Returns:

  • Object the value of the variable, or nil if it’s not found

API:

  • public



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
 
# File 'lib/puppet/parser/scope.rb', line 400

def lookupvar(name, options = {})
  unless name.is_a? String
    raise Puppet::ParseError, "Scope variable name #{name.inspect} is a #{name.class}, not a string"
  end

  table = @ephemeral.last

  if name =~ /^(.*)::(.+)$/
    class_name = $1
    variable_name = $2
    lookup_qualified_variable(class_name, variable_name, options)

  # TODO: optimize with an assoc instead, this searches through scopes twice for a hit
  elsif table.include?(name)
    table[name]
  else
    next_scope = inherited_scope || enclosing_scope
    if next_scope
      next_scope.lookupvar(name, options)
    else
      variable_not_found(name)
    end
  end
end

#new_ephemeral(local_scope = false) ⇒ Object

TODO: Who calls this?

API:

  • public



787
788
789
790
791
792
793
 
# File 'lib/puppet/parser/scope.rb', line 787

def new_ephemeral(local_scope = false)
  if local_scope
    @ephemeral.push(LocalScope.new(@ephemeral.last))
  else
    @ephemeral.push(MatchScope.new(@ephemeral.last, nil))
  end
end

#new_match_scope(match_data) ⇒ Object

Nests a match data scope

API:

  • public



802
803
804
 
# File 'lib/puppet/parser/scope.rb', line 802

def new_match_scope(match_data)
  @ephemeral.push(MatchScope.new(@ephemeral.last, match_data))
end

#newscope(options = {}) ⇒ Object

Create a new scope and set these options.

API:

  • public



612
613
614
 
# File 'lib/puppet/parser/scope.rb', line 612

def newscope(options = {})
  compiler.newscope(self, options)
end

#parent_module_name ⇒ Object

API:

  • public



616
617
618
619
620
 
# File 'lib/puppet/parser/scope.rb', line 616

def parent_module_name
  return nil unless @parent
  return nil unless @parent.source
  @parent.source.module_name
end

#resolve_type_and_titles(type, titles) ⇒ Object

Raises:

API:

  • public



852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
 
# File 'lib/puppet/parser/scope.rb', line 852

def resolve_type_and_titles(type, titles)
  raise ArgumentError, "titles must be an array" unless titles.is_a?(Array)

  case type.downcase
  when "class"
    # resolve the titles
    titles = titles.collect do |a_title|
      hostclass = find_hostclass(a_title)
      hostclass ?  hostclass.name : a_title
    end
  when "node"
    # no-op
  else
    # resolve the type
    resource_type = find_resource_type(type)
    type = resource_type.name if resource_type
  end

  return [type, titles]
end

#set_facts(hash) ⇒ Object

API:

  • public



684
685
686
687
688
689
690
 
# File 'lib/puppet/parser/scope.rb', line 684

def set_facts(hash)
  # Remove _timestamp (it has an illegal datatype). It is not allowed to mutate the given hash
  # since it contains the facts.
  hash = hash.dup
  hash.delete('_timestamp')
  setvar('facts', deep_freeze(hash), :privileged => true)
end

#set_match_data(match_data) ⇒ Object

Sets match data in the most nested scope (which always is a MatchScope), it clobbers match data already set there

API:

  • public



797
798
799
 
# File 'lib/puppet/parser/scope.rb', line 797

def set_match_data(match_data)
  @ephemeral.last.match_data = match_data
end

#set_trusted(hash) ⇒ Object

API:

  • public



680
681
682
 
# File 'lib/puppet/parser/scope.rb', line 680

def set_trusted(hash)
  setvar('trusted', deep_freeze(hash), :privileged => true)
end

#setvar(name, value, options = {}) ⇒ Object

Set a variable in the current scope. This will override settings in scopes above, but will not allow variables in the current scope to be reassigned.

It's preferred that you use self[]= instead of this; only use this

when you need to set options.

API:

  • public



646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
 
# File 'lib/puppet/parser/scope.rb', line 646

def setvar(name, value, options = {})
  if name =~ /^[0-9]+$/
    raise Puppet::ParseError.new("Cannot assign to a numeric match result variable '$#{name}'") # unless options[:ephemeral]
  end
  unless name.is_a? String
    raise Puppet::ParseError, "Scope variable name #{name.inspect} is a #{name.class}, not a string"
  end

  # Check for reserved variable names
  if @enable_immutable_data && !options[:privileged] && RESERVED_VARIABLE_NAMES.include?(name)
    raise Puppet::ParseError, "Attempt to assign to a reserved variable name: '#{name}'"
  end

  table = effective_symtable(options[:ephemeral])
  if table.bound?(name)
    if options[:append]
      error = Puppet::ParseError.new("Cannot append, variable #{name} is defined in this scope")
    else
      error = Puppet::ParseError.new("Cannot reassign variable #{name}")
    end
    error.file = options[:file] if options[:file]
    error.line = options[:line] if options[:line]
    raise error
  end

  if options[:append]
    # produced result (value) is the resulting appended value, note: the table[]= does not return the value
    table[name] = (value = append_value(undef_as('', self[name]), value))
  else
    table[name] = value
  end
  value
end

#to_hash(recursive = true) ⇒ Object

Returns a Hash containing all variables and their values, optionally (and by default) including the values defined in parent. Local values shadow parent values. Ephemeral scopes for match results ($0 - $n) are not included.

This is currently a wrapper for to_hash_legacy or to_hash_future.

See Also:

API:

  • public



563
564
565
566
567
568
569
570
 
# File 'lib/puppet/parser/scope.rb', line 563

def to_hash(recursive = true)
  @future_parser ||= Puppet.future_parser?
  if @future_parser
    to_hash_future(recursive)
  else
    to_hash_legacy(recursive)
  end
end

#to_hash_future(recursive) ⇒ Object

Fixed version of to_hash that implements scoping correctly (i.e., with dynamic scoping disabled #28200 / PUP-1220

See Also:

API:

  • public



576
577
578
579
580
581
582
583
584
585
586
587
588
589
 
# File 'lib/puppet/parser/scope.rb', line 576

def to_hash_future(recursive)
  if recursive and has_enclosing_scope?
    target = enclosing_scope.to_hash_future(recursive)
    if !(inherited = inherited_scope).nil?
      target.merge!(inherited.to_hash_future(recursive))
    end
  else
    target = Hash.new
  end

  # add all local scopes
  @ephemeral.last.add_entries_to(target)
  target
end

#to_hash_legacy(recursive = true) ⇒ Object

The old broken implementation of to_hash that retains the dynamic scoping semantics

See Also:

API:

  • public



595
596
597
598
599
600
601
602
603
604
605
 
# File 'lib/puppet/parser/scope.rb', line 595

def to_hash_legacy(recursive = true)
  if recursive and parent
    target = parent.to_hash_legacy(recursive)
  else
    target = Hash.new
  end

  # add all local scopes
  @ephemeral.last.add_entries_to(target)
  target
end

#to_s ⇒ Object

Used mainly for logging

API:

  • public



767
768
769
 
# File 'lib/puppet/parser/scope.rb', line 767

def to_s
  "Scope(#{@resource})"
end

#transform_and_assert_classnames(names) ⇒ Array<String>

Transforms references to classes to the form suitable for lookup in the compiler.

Makes names passed in the names array absolute if they are relative Names are now made absolute if Puppet.future_parser? is true, this will be the default behavior in Puppet 4.0

Transforms Class[] and Resource[] type referenes to class name or raises an error if a Class[] is unspecific, if a Resource is not a ‘class’ resource, or if unspecific (no title).

TODO: Change this for 4.0 to always make names absolute

Parameters:

  • names to (optionally) make absolute

Returns:

  • names after transformation

API:

  • public



889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
 
# File 'lib/puppet/parser/scope.rb', line 889

def transform_and_assert_classnames(names)
  if Puppet.future_parser?
    names.map do |name|
      case name
      when String
        name.sub(/^([^:]{1,2})/, '::\1')

      when Puppet::Resource
        assert_class_and_title(name.type, name.title)
        name.title.sub(/^([^:]{1,2})/, '::\1')

      when Puppet::Pops::Types::PHostClassType
        raise ArgumentError, "Cannot use an unspecific Class[] Type" unless name.class_name
        name.class_name.sub(/^([^:]{1,2})/, '::\1')

      when Puppet::Pops::Types::PResourceType
        assert_class_and_title(name.type_name, name.title)
        name.title.sub(/^([^:]{1,2})/, '::\1')
      end
    end
  else
    names
  end
end

#undef_as(x, v) ⇒ Object

API:

  • public



383
384
385
386
387
388
389
 
# File 'lib/puppet/parser/scope.rb', line 383

def undef_as(x,v)
  if v.nil? or v == :undef
    x
  else
    v
  end
end

#unset_ephemeral_var(level = :all) ⇒ Object

remove ephemeral scope up to level TODO: Who uses :all ? Remove ??

API:

  • public



774
775
776
777
778
779
780
 
# File 'lib/puppet/parser/scope.rb', line 774

def unset_ephemeral_var(level=:all)
  if level == :all
    @ephemeral = [ MatchScope.new(@symtable, nil)]
  else
    @ephemeral.pop(@ephemeral.size - level)
  end
end

#variable_not_found(name, reason = nil) ⇒ Object

API:

  • public



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/puppet/parser/scope.rb', line 425

def variable_not_found(name, reason=nil)
  # Built in variables always exist
  if BUILT_IN_VARS.include?(name)
    return nil
  end
  if Puppet[:strict_variables]
    if Puppet.future_parser?
      throw :undefined_variable
    else
      reason_msg = reason.nil? ? '' : "; #{reason}"
      raise Puppet::ParseError, "Undefined variable #{name.inspect}#{reason_msg}"
    end
  else
    nil
  end
end