Puppet Function: suffix

Defined in:
puppet/modules/stdlib/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, or to the keys in a hash.

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
43
44
45
46
47
48
49
50
 
# File 'puppet/modules/stdlib/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, or to the keys
in a hash.

*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

  enumerable = arguments[0]

  unless enumerable.is_a?(Array) or enumerable.is_a?(Hash)
    raise Puppet::ParseError, "suffix(): expected first argument to be an Array or a Hash, got #{enumerable.inspect}"
  end

  suffix = arguments[1] if arguments[1]

  if suffix
    unless suffix.is_a? String
      raise Puppet::ParseError, "suffix(): expected second argument to be a String, got #{suffix.inspect}"
    end
  end

  if enumerable.is_a?(Array)
    # Turn everything into string same as join would do ...
    result = enumerable.collect do |i|
      i = i.to_s
      suffix ? i + suffix : i
    end
  else
    result = Hash[enumerable.map do |k,v|
      k = k.to_s
      [ suffix ? k + suffix : k, v ]
    end]
  end

  return result
end