Class: Puppet::Functions::DispatcherBuilder

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

Overview

Public api methods of the DispatcherBuilder are available within dispatch() blocks declared in a Puppet::Function.create_function() call.

Direct Known Subclasses

InternalDispatchBuilder

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(dispatcher, type_parser, all_callables, loader) ⇒ DispatcherBuilder

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 DispatcherBuilder.



348
349
350
351
352
353
 
# File 'lib/puppet/functions.rb', line 348

def initialize(dispatcher, type_parser, all_callables, loader)
  @type_parser = type_parser
  @all_callables = all_callables
  @dispatcher = dispatcher
  @loader = loader
end

Instance Attribute Details

#loader ⇒ Object (readonly) 



345
346
347
 
# File 'lib/puppet/functions.rb', line 345

def loader
  @loader
end

Instance Method Details

#block_param(*type_and_name) ⇒ Object Also known as: required_block_param

Defines one required block parameter that may appear last. If type and name is missing the default type is “Callable”, and the name is “block”. If only one parameter is given, then that is the name and the type is “Callable”.



425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
 
# File 'lib/puppet/functions.rb', line 425

def block_param(*type_and_name)
  case type_and_name.size
  when 0
    type = @all_callables
    name = :block
  when 1
    type = @all_callables
    name = type_and_name[0]
  when 2
    type_string, name = type_and_name
    type = @type_parser.parse(type_string, loader)
  else
    raise ArgumentError, "block_param accepts max 2 arguments (type, name), got #{type_and_name.size}."
  end

  unless Puppet::Pops::Types::TypeCalculator.is_kind_of_callable?(type, false)
    raise ArgumentError, "Expected PCallableType or PVariantType thereof, got #{type.class}"
  end

  unless name.is_a?(Symbol)
    raise ArgumentError, "Expected block_param name to be a Symbol, got #{name.class}"
  end

  if @block_type.nil?
    @block_type = type
    @block_name = name
  else
    raise ArgumentError, 'Attempt to redefine block'
  end
end

#optional_block_param(*type_and_name) ⇒ Object

Defines one optional block parameter that may appear last. If type or name is missing the defaults are “any callable”, and the name is “block”. The implementor of the dispatch target must use block = nil when it is optional (or an error is raised when the call is made).



462
463
464
465
466
 
# File 'lib/puppet/functions.rb', line 462

def optional_block_param(*type_and_name)
  # same as required, only wrap the result in an optional type
  required_block_param(*type_and_name)
  @block_type = Puppet::Pops::Types::TypeFactory.optional(@block_type)
end

#optional_param(type, name) ⇒ Void

Defines an optional positional parameter with type and name. May not be followed by a required parameter.

Parameters:

  • type (String) —

    The type specification for the parameter.

  • name (Symbol) —

    The name of the parameter. This is primarily used for error message output and does not have to match an implementation method parameter.

Returns:

  • (Void) 


382
383
384
385
 
# File 'lib/puppet/functions.rb', line 382

def optional_param(type, name)
  internal_param(type, name)
  @max += 1
end

#param(type, name) ⇒ Void Also known as: required_param

Defines a required positional parameter with type and name.

Parameters:

  • type (String) —

    The type specification for the parameter.

  • name (Symbol) —

    The name of the parameter. This is primarily used for error message output and does not have to match an implementation method parameter.

Returns:

  • (Void)

Raises:

  • (ArgumentError) 


364
365
366
367
368
369
 
# File 'lib/puppet/functions.rb', line 364

def param(type, name)
  internal_param(type, name)
  raise ArgumentError, 'A required parameter cannot be added after an optional parameter' if @min != @max
  @min += 1
  @max += 1
end

#repeated_param(type, name) ⇒ Void Also known as: optional_repeated_param

Defines a repeated positional parameter with type and name that may occur 0 to “infinite” number of times. It may only appear last or just before a block parameter.

Parameters:

  • type (String) —

    The type specification for the parameter.

  • name (Symbol) —

    The name of the parameter. This is primarily used for error message output and does not have to match an implementation method parameter.

Returns:

  • (Void) 


397
398
399
400
 
# File 'lib/puppet/functions.rb', line 397

def repeated_param(type, name)
  internal_param(type, name, true)
  @max = :default
end

#required_repeated_param(type, name) ⇒ Void

Defines a repeated positional parameter with type and name that may occur 1 to “infinite” number of times. It may only appear last or just before a block parameter.

Parameters:

  • type (String) —

    The type specification for the parameter.

  • name (Symbol) —

    The name of the parameter. This is primarily used for error message output and does not have to match an implementation method parameter.

Returns:

  • (Void)

Raises:

  • (ArgumentError) 


413
414
415
416
417
418
 
# File 'lib/puppet/functions.rb', line 413

def required_repeated_param(type, name)
  internal_param(type, name, true)
  raise ArgumentError, 'A required repeated parameter cannot be added after an optional parameter' if @min != @max
  @min += 1
  @max = :default
end

#return_type(type) ⇒ Object

Defines the return type. Defaults to ‘Any’

Parameters:

  • type (String) —

    a reference to a Puppet Data Type

Raises:

  • (ArgumentError) 


472
473
474
475
 
# File 'lib/puppet/functions.rb', line 472

def return_type(type)
  raise ArgumentError, "Argument to 'return_type' must be a String reference to a Puppet Data Type. Got #{type.class}" unless type.is_a?(String)
  @return_type = type
end