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.

Defined Under Namespace

Classes: Ephemeral, LocalScope, MatchScope

Constant Summary collapse

AST = 
Puppet::Parser::AST
RESERVED_VARIABLE_NAMES = 
['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:



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

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 



811
812
813
814
815
816
817
818
819
820
821
822
823
 
# File 'lib/puppet/parser/scope.rb', line 811

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 



29
30
31
 
# File 'lib/puppet/parser/scope.rb', line 29

def compiler
  @compiler
end

#defaults ⇒ Object (readonly)

Hash of hashes of default values per type name



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

def defaults
  @defaults
end

#namespaces ⇒ Object (readonly) 



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

def namespaces
  @namespaces
end

#parent ⇒ Object 



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

def parent
  @parent
end

#resource ⇒ Object 



28
29
30
 
# File 'lib/puppet/parser/scope.rb', line 28

def resource
  @resource
end

#source ⇒ Object 



28
29
30
 
# File 'lib/puppet/parser/scope.rb', line 28

def source
  @source
end

Class Method Details

.number?(value) ⇒ Boolean

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

Returns:

  • (Boolean) 


210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
 
# File 'lib/puppet/parser/scope.rb', line 210

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:

  • (Boolean) 


198
199
200
201
202
203
204
205
206
207
 
# File 'lib/puppet/parser/scope.rb', line 198

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:

  • varname (String) —

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

  • options (Hash) (defaults to: {}) —

    Additional options, not part of api.

Returns:

  • (Object) —

    the value assigned to the given varname

See Also:



425
426
427
 
# File 'lib/puppet/parser/scope.rb', line 425

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:

  • varname (String) —

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

  • value (String) —

    The value to assign to the given variable name.

  • options (Hash) (defaults to: {}) —

    Additional options, not part of api.



717
718
719
 
# File 'lib/puppet/parser/scope.rb', line 717

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

#add_namespace(ns) ⇒ Object

Add to our list of namespaces.



228
229
230
231
232
233
234
235
 
# File 'lib/puppet/parser/scope.rb', line 228

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:

  • (Boolean) 


191
192
193
194
 
# File 'lib/puppet/parser/scope.rb', line 191

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.



317
318
319
320
321
 
# File 'lib/puppet/parser/scope.rb', line 317

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.



305
306
307
308
309
310
311
 
# File 'lib/puppet/parser/scope.rb', line 305

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.



598
599
600
601
602
603
604
605
606
607
608
609
610
 
# File 'lib/puppet/parser/scope.rb', line 598

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:

  • use_ephemeral (Boolean) —

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



694
695
696
697
698
699
700
701
702
703
704
 
# File 'lib/puppet/parser/scope.rb', line 694

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:



448
449
450
451
452
453
454
455
456
457
458
 
# File 'lib/puppet/parser/scope.rb', line 448

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 



779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
 
# File 'lib/puppet/parser/scope.rb', line 779

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 



755
756
757
 
# File 'lib/puppet/parser/scope.rb', line 755

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:

  • (Boolean) 


184
185
186
187
 
# File 'lib/puppet/parser/scope.rb', line 184

def exist?(name)
  next_scope = inherited_scope || enclosing_scope
  effective_symtable(true).include?(name) || next_scope && next_scope.exist?(name)
end

#find_builtin_resource_type(type) ⇒ Object 



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

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

#find_defined_resource_type(type) ⇒ Object 



806
807
808
 
# File 'lib/puppet/parser/scope.rb', line 806

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

#find_definition(name) ⇒ Object 



241
242
243
 
# File 'lib/puppet/parser/scope.rb', line 241

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

#find_global_scope ⇒ Object 



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/puppet/parser/scope.rb', line 245

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 



237
238
239
 
# File 'lib/puppet/parser/scope.rb', line 237

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

#find_resource_type(type) ⇒ Object 



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

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:

  • (Boolean) 


178
179
180
 
# File 'lib/puppet/parser/scope.rb', line 178

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:



433
434
435
436
437
438
439
 
# File 'lib/puppet/parser/scope.rb', line 433

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

#is_classscope? ⇒ Boolean

Returns:

  • (Boolean) 


460
461
462
 
# File 'lib/puppet/parser/scope.rb', line 460

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

#is_nodescope? ⇒ Boolean

Returns:

  • (Boolean) 


464
465
466
 
# File 'lib/puppet/parser/scope.rb', line 464

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

#is_topscope? ⇒ Boolean

Returns:

  • (Boolean) 


468
469
470
 
# File 'lib/puppet/parser/scope.rb', line 468

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:

  • class_name (String) —

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

  • variable_name (String) —

    the variable name without the absolute leading ‘::’

Returns:

  • (Boolean) —

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



502
503
504
505
506
507
508
 
# File 'lib/puppet/parser/scope.rb', line 502

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 



472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
 
# File 'lib/puppet/parser/scope.rb', line 472

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



334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/puppet/parser/scope.rb', line 334

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.



356
357
358
 
# File 'lib/puppet/parser/scope.rb', line 356

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:

  • name (String) —

    the variable name to lookup

Returns:

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



377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
 
# File 'lib/puppet/parser/scope.rb', line 377

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?



760
761
762
763
764
765
766
 
# File 'lib/puppet/parser/scope.rb', line 760

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



775
776
777
 
# File 'lib/puppet/parser/scope.rb', line 775

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.



585
586
587
 
# File 'lib/puppet/parser/scope.rb', line 585

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

#parent_module_name ⇒ Object 



589
590
591
592
593
 
# File 'lib/puppet/parser/scope.rb', line 589

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:

  • (ArgumentError) 


825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
 
# File 'lib/puppet/parser/scope.rb', line 825

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 



657
658
659
660
661
662
663
 
# File 'lib/puppet/parser/scope.rb', line 657

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



770
771
772
 
# File 'lib/puppet/parser/scope.rb', line 770

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

#set_trusted(hash) ⇒ Object 



653
654
655
 
# File 'lib/puppet/parser/scope.rb', line 653

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.



619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
 
# File 'lib/puppet/parser/scope.rb', line 619

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:



536
537
538
539
540
541
542
543
 
# File 'lib/puppet/parser/scope.rb', line 536

def to_hash(recursive = true)
  @parser ||= Puppet[:parser]
  if @parser == 'future'
    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:



549
550
551
552
553
554
555
556
557
558
559
560
561
562
 
# File 'lib/puppet/parser/scope.rb', line 549

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:



568
569
570
571
572
573
574
575
576
577
578
 
# File 'lib/puppet/parser/scope.rb', line 568

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



740
741
742
 
# File 'lib/puppet/parser/scope.rb', line 740

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’, 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 (Array<String>) —

    names to (optionally) make absolute

Returns:



862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
 
# File 'lib/puppet/parser/scope.rb', line 862

def transform_and_assert_classnames(names)
  if Puppet[:parser] == 'future'
    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 



360
361
362
363
364
365
366
 
# File 'lib/puppet/parser/scope.rb', line 360

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 ??



747
748
749
750
751
752
753
 
# File 'lib/puppet/parser/scope.rb', line 747

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 



402
403
404
405
406
407
408
409
410
411
412
413
 
# File 'lib/puppet/parser/scope.rb', line 402

def variable_not_found(name, reason=nil)
  if Puppet[:strict_variables]
    if Puppet[:parser] == 'future'
      throw :undefined_variable
    else
      reason_msg = reason.nil? ? '' : "; #{reason}"
      raise Puppet::ParseError, "Undefined variable #{name.inspect}#{reason_msg}"
    end
  else
    nil
  end
end