Puppet Function: suffix

Defined in:
lib/puppet/parser/functions/suffix.rb
Function type:
Ruby 3.x API

Overview

suffix() ⇒ Any

This function applies a suffix to all elements in an array.

Examples:

suffix(['a','b','c'], 'p')

Will return: [‘ap’,‘bp’,‘cp’]

Returns:

  • (Any) 


6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'lib/puppet/parser/functions/suffix.rb', line 6

newfunction(:suffix, :type => :rvalue, :doc => <<-EOS
This function applies a suffix to all elements in an array.

*Examples:*

  suffix(['a','b','c'], 'p')

Will return: ['ap','bp','cp']
  EOS
) do |arguments|

  # Technically we support two arguments but only first is mandatory ...
  raise(Puppet::ParseError, "suffix(): Wrong number of arguments " +
    "given (#{arguments.size} for 1)") if arguments.size < 1

  array = arguments[0]

  unless array.is_a?(Array)
    raise(Puppet::ParseError, 'suffix(): Requires array to work with')
  end

  suffix = arguments[1] if arguments[1]

  if suffix
    unless suffix.is_a?(String)
      raise(Puppet::ParseError, 'suffix(): Requires string to work with')
    end
  end

  # Turn everything into string same as join would do ...
  result = array.collect do |i|
    i = i.to_s
    suffix ? i + suffix : i
  end

  return result
end