Class Puppet::Parser::Scope
In: lib/puppet/parser/scope.rb
Parent: Object

Methods

add_namespace   catalog   class_scope   class_set   environment   environment   ephemeral?   ephemeral_from   ephemeral_include?   ephemeral_level   find_builtin_resource_type   find_defined_resource_type   find_definition   find_hostclass   find_resource_type   findresource   host   lookupdefaults   lookuptype   lookupvar   namespaces   new   new_ephemeral   newscope   number?   parent_module_name   resolve_type_and_titles   scope_path   setdefaults   setvar   strinterp   tags   to_hash   to_s   topscope?   true?   unset_ephemeral_var   unsetvar  

Included Modules

Puppet::Resource::TypeCollectionHelper Enumerable Puppet::Util::Errors

Classes and Modules

Class Puppet::Parser::Scope::Ephemeral

Constants

AST = Puppet::Parser::AST

Attributes

base  [RW] 
compiler  [RW] 
keyword  [RW] 
level  [RW] 
namespaces  [R] 
parent  [RW] 
resource  [RW] 
source  [RW] 
top  [RW] 
translated  [RW] 

Public Class methods

new(hash = {})

Initialize our new scope. Defaults to having no parent.

number?(value)

Is the value a number?, return the correct object or nil if not a number

true?(value)

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

Public Instance methods

add_namespace(ns)

Add to our list of namespaces.

catalog()

A demeterific shortcut to the catalog.

class_scope(klass)

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.

class_set(name, scope)

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.

environment()

Remove this when rebasing

ephemeral?(name)

is name an ephemeral variable?

ephemeral_include?(name)

check if name exists in one of the ephemeral scope.

host()

Proxy accessors

lookupdefaults(type)

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.

lookuptype(name)

Look up a defined type.

lookupvar(name, usestring = true)

Look up a variable. The simplest value search we do. Default to returning an empty string for missing values, but support returning a constant.

newscope(options = {})

Create a new scope and set these options.

scope_path()

Return the list of scopes up to the top scope, ordered with our own first. This is used for looking up variables and defaults.

setdefaults(type, params)

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.

setvar(name,value, options = {})

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.

strinterp(string, file = nil, line = nil)

Return an interpolated string.

tags()

Return the tags associated with this scope. It‘s basically just our parents’ tags, plus our type. We don‘t cache this value because our parent tags might change between calls.

to_hash(recursive = true)

Return a hash containing our variables and their values, optionally (and by default) including the values defined in our parent. Local values shadow parent values.

to_s()

Used mainly for logging

topscope?()

Are we the top scope?

unset_ephemeral_var(level=:all)

remove ephemeral scope up to level

unsetvar(var)

Undefine a variable; only used for testing.

[Validate]