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 Method Summary collapse

Constructor Details

#initialize(dispatcher, type_parser, all_callables) ⇒ 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.



282
283
284
285
286
 
# File 'lib/puppet/functions.rb', line 282

def initialize(dispatcher, type_parser, all_callables)
  @type_parser = type_parser
  @all_callables = all_callables
  @dispatcher = dispatcher
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”.



358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
 
# File 'lib/puppet/functions.rb', line 358

def block_param(*type_and_name)
  case type_and_name.size
  when 0
    # the type must be an independent instance since it will be contained in another type
    type = @all_callables.copy
    name = 'block'
  when 1
    # the type must be an independent instance since it will be contained in another type
    type = @all_callables.copy
    name = type_and_name[0]
  when 2
    type_string, name = type_and_name
    type = @type_parser.parse(type_string)
  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?(String) || name.is_a?(Symbol)
    raise ArgumentError, "Expected block_param name to be a String or 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).



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

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) 


315
316
317
318
 
# File 'lib/puppet/functions.rb', line 315

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) 


297
298
299
300
301
302
 
# File 'lib/puppet/functions.rb', line 297

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) 


330
331
332
333
 
# File 'lib/puppet/functions.rb', line 330

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) 


346
347
348
349
350
351
 
# File 'lib/puppet/functions.rb', line 346

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