Class: Puppet::Functions::InternalFunction Private

Inherits:
Function show all
Defined in:
lib/puppet/functions.rb

Overview

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.

Note:

WARNING: This style of creating functions is not public. It is a system under development that will be used for creating “system” functions.

This is a private, internal, system for creating functions. It supports everything that the public function definition system supports as well as a few extra features.

Injection Support

The Function API supports injection of data and services. It is possible to make injection that takes effect when the function is loaded (for services and runtime configuration that does not change depending on how/from where in what context the function is called. It is also possible to inject and weave argument values into a call.

Injection of attributes

Injection of attributes is performed by one of the methods ‘attr_injected`, and `attr_injected_producer`. The injected attributes are available via accessor method calls.

Examples:

using injected attributes

Puppet::Functions.create_function('test') do
  attr_injected String, :larger, 'message_larger'
  attr_injected String, :smaller, 'message_smaller'
  def test(a, b)
    a > b ? larger() : smaller()
  end
end

Instance Attribute Summary

Attributes inherited from Pops::Functions::Function

#closure_scope, #loader

Class Method Summary collapse

Methods inherited from Function

dispatch

Methods inherited from Pops::Functions::Function

#call, #call_function, dispatcher, #initialize, signatures

Constructor Details

This class inherits a constructor from Puppet::Pops::Functions::Function

Class Method Details

.attr_injected(type, attribute_name, injection_name = nil) ⇒ 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.

Defines class level injected attribute with reader method



450
451
452
453
454
455
456
457
458
459
 
# File 'lib/puppet/functions.rb', line 450

def self.attr_injected(type, attribute_name, injection_name = nil)
  define_method(attribute_name) do
    ivar = :"@#{attribute_name.to_s}"
    unless instance_variable_defined?(ivar)
      injector = Puppet.lookup(:injector)
      instance_variable_set(ivar, injector.lookup(closure_scope, type, injection_name))
    end
    instance_variable_get(ivar)
  end
end

.attr_injected_producer(type, attribute_name, injection_name = nil) ⇒ 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.

Defines class level injected producer attribute with reader method



464
465
466
467
468
469
470
471
472
473
 
# File 'lib/puppet/functions.rb', line 464

def self.attr_injected_producer(type, attribute_name, injection_name = nil)
  define_method(attribute_name) do
    ivar = :"@#{attribute_name.to_s}"
    unless instance_variable_defined?(ivar)
      injector = Puppet.lookup(:injector)
      instance_variable_set(ivar, injector.lookup_producer(closure_scope, type, injection_name))
    end
    instance_variable_get(ivar)
  end
end

.builder ⇒ 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. 



441
442
443
444
445
 
# File 'lib/puppet/functions.rb', line 441

def self.builder
  @type_parser ||= Puppet::Pops::Types::TypeParser.new
  @all_callables ||= Puppet::Pops::Types::TypeFactory.all_callables
  InternalDispatchBuilder.new(dispatcher, @type_parser, @all_callables)
end