Class: Puppet::Pops::Functions::Dispatch Private

Inherits:
Evaluator::CallableSignature show all
Defined in:
lib/puppet/pops/functions/dispatch.rb

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.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Evaluator::CallableSignature

#args_range, #block_range, #block_type, #infinity?

Constructor Details

#initialize(type, method_name, param_names, last_captures = false, block_name = nil, injections = EMPTY_ARRAY, weaving = EMPTY_ARRAY, argument_mismatch_handler = false) ⇒ Dispatch

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.

Returns a new instance of Dispatch.

Parameters:

  • type (Puppet::Pops::Types::PArrayType, Puppet::Pops::Types::PTupleType) —

    • type describing signature

  • method_name (String) —

    the name of the method that will be called when type matches given arguments

  • param_names (Array<String>) —

    names matching the number of parameters specified by type (or empty array)

  • block_name (String, nil) (defaults to: nil) —

    name of block parameter, no nil

  • injections (Array<Array>) (defaults to: EMPTY_ARRAY) —

    injection data for weaved parameters

  • weaving (Array<Integer,Array>) (defaults to: EMPTY_ARRAY) —

    weaving knits

  • last_captures (Boolean) (defaults to: false) —

    true if last parameter is captures rest

  • argument_mismatch_handler (Boolean) (defaults to: false) —

    true if this is a dispatch for an argument mismatch



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/puppet/pops/functions/dispatch.rb', line 33

def initialize(type, method_name, param_names, last_captures = false, block_name = nil, injections = EMPTY_ARRAY, weaving = EMPTY_ARRAY, argument_mismatch_handler = false)
  @type = type
  @method_name = method_name
  @param_names = param_names
  @last_captures = last_captures
  @block_name = block_name
  @injections = injections
  @weaving = weaving
  @argument_mismatch_handler = argument_mismatch_handler
end

Instance Attribute Details

#block_name ⇒ Object (readonly) 



22
23
24
 
# File 'lib/puppet/pops/functions/dispatch.rb', line 22

def block_name
  @block_name
end

#injections ⇒ Object (readonly)

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. 



15
16
17
 
# File 'lib/puppet/pops/functions/dispatch.rb', line 15

def injections
  @injections
end

#param_names ⇒ Object (readonly)

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.

TODO: refactor to parameter_names since that makes it API



14
15
16
 
# File 'lib/puppet/pops/functions/dispatch.rb', line 14

def param_names
  @param_names
end

#type ⇒ Object (readonly) 



12
13
14
 
# File 'lib/puppet/pops/functions/dispatch.rb', line 12

def type
  @type
end

#weaving ⇒ Object (readonly)

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.

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



20
21
22
 
# File 'lib/puppet/pops/functions/dispatch.rb', line 20

def weaving
  @weaving
end

Instance Method Details

#argument_mismatch_handler? ⇒ Boolean

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.

Returns:

  • (Boolean) 


54
55
56
 
# File 'lib/puppet/pops/functions/dispatch.rb', line 54

def argument_mismatch_handler?
  @argument_mismatch_handler
end

#invoke(instance, calling_scope, args, &block) ⇒ 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. 



59
60
61
62
63
64
 
# File 'lib/puppet/pops/functions/dispatch.rb', line 59

def invoke(instance, calling_scope, args, &block)
  result = instance.send(@method_name, *weave(calling_scope, args), &block)
  return_type = @type.return_type
  Types::TypeAsserter.assert_instance_of(nil, return_type, result) { "value returned from function '#{@method_name}'" } unless return_type.nil?
  result
end

#last_captures_rest? ⇒ Boolean

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.

Returns:

  • (Boolean) 


50
51
52
 
# File 'lib/puppet/pops/functions/dispatch.rb', line 50

def last_captures_rest?
  @last_captures
end

#parameter_names ⇒ 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. 



45
46
47
 
# File 'lib/puppet/pops/functions/dispatch.rb', line 45

def parameter_names
  @param_names
end

#weave(scope, args) ⇒ 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. 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/puppet/pops/functions/dispatch.rb', line 67

def weave(scope, args)
  # no need to weave if there are no injections
  if @injections.empty?
    args
  else
    new_args = []
    @weaving.each do |knit|
      if knit.is_a?(Array)
        injection_name = @injections[knit[0]]
        new_args <<
          case injection_name
          when :scope
            scope
          when :pal_script_compiler
            Puppet.lookup(:pal_script_compiler)
          when :cache
            Puppet::Pops::Adapters::ObjectIdCacheAdapter.adapt(scope.compiler)
          when :pal_catalog_compiler
            Puppet.lookup(:pal_catalog_compiler)
          when :pal_compiler
            Puppet.lookup(:pal_compiler)
          else
            raise ArgumentError, _("Unknown injection %{injection_name}") % { injection_name: injection_name }
          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