class Puppet::Pops::Functions::Dispatch

Defines a connection between a implementation method and the signature that the method will handle.

This interface should not be used directly. Instead dispatches should be constructed using the DSL defined in {Puppet::Functions}.

@api private

Attributes

block_name[R]

@api public

injections[R]

param_names[R]

TODO: refactor to #parameter_names since that makes it API

type[R]

@api public

weaving[R]

Describes how arguments are woven if there are injections, a regular argument is a given arg index, an array an injection description.

Public Instance Methods

invoke(instance, calling_scope, args, &block) click to toggle source

@api private

# File lib/puppet/pops/functions/dispatch.rb, line 44
def invoke(instance, calling_scope, args, &block)
  instance.send(@method_name, *weave(calling_scope, args), &block)
end

last_captures_rest?() click to toggle source

@api private

# File lib/puppet/pops/functions/dispatch.rb, line 39
def last_captures_rest?
  !! @last_captures
end

parameter_names() click to toggle source

@api private

# File lib/puppet/pops/functions/dispatch.rb, line 34
def parameter_names
  @param_names
end

weave(scope, args) click to toggle source

@api private

# File lib/puppet/pops/functions/dispatch.rb, line 49
def weave(scope, args)
  # no need to weave if there are no injections
  if @injections.empty?
    args
  else
    injector = nil # lazy lookup of injector Puppet.lookup(:injector)
    new_args = []
    @weaving.each do |knit|
      if knit.is_a?(Array)
        injection_data = @injections[knit[0]]
        new_args <<
          case injection_data[3]
          when :dispatcher_internal
            # currently only supports :scope injection
            scope
          when :producer
            injector ||= Puppet.lookup(:injector)
            injector.lookup_producer(scope, injection_data[0], injection_data[2])
          else
            injector ||= Puppet.lookup(:injector)
            injector.lookup(scope, injection_data[0], injection_data[2])
          end
      else
        # Careful so no new nil arguments are added since they would override default
        # parameter values in the received
        if knit < 0
          idx = -knit - 1
          new_args += args[idx..-1] if idx < args.size
        else
          new_args << args[knit] if knit < args.size
        end
      end
    end
    new_args
  end
end

Public Class Methods

new(type, method_name, param_names, block_name, injections, weaving, last_captures) click to toggle source

@api private

# File lib/puppet/pops/functions/dispatch.rb, line 23
def initialize(type, method_name, param_names, block_name, injections, weaving, last_captures)
  @type = type
  @method_name = method_name
  @param_names = param_names || []
  @block_name = block_name
  @injections = injections || []
  @weaving = weaving
  @last_captures = last_captures
end