Puppet Function: ensure_prefix

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

Overview

ensure_prefix() ⇒ Any

This function ensures a prefix for all elements in an array or the keys in a hash.

Examples:

ensure_prefix({'a' => 1, 'b' => 2, 'p.c' => 3}, 'p.')

Will return:

{
  'p.a' => 1,
  'p.b' => 2,
  'p.c' => 3,
}

ensure_prefix(['a', 'p.b', 'c'], 'p.')

Will return:

['p.a', 'p.b', 'p.c']

Returns:

  • (Any) 


4
5
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
51
 
# File 'lib/puppet/parser/functions/ensure_prefix.rb', line 4

newfunction(:ensure_prefix, type: :rvalue, doc: <<-EOS
  This function ensures a prefix for all elements in an array or the keys in a hash.

  *Examples:*

    ensure_prefix({'a' => 1, 'b' => 2, 'p.c' => 3}, 'p.')

  Will return:
    {
      'p.a' => 1,
      'p.b' => 2,
      'p.c' => 3,
    }

    ensure_prefix(['a', 'p.b', 'c'], 'p.')

  Will return:
    ['p.a', 'p.b', 'p.c']
EOS
) do |arguments|
  if arguments.size < 2
    raise(Puppet::ParseError, 'ensure_prefix(): Wrong number of arguments ' \
                              "given (#{arguments.size} for 2)")
  end

  enumerable = arguments[0]

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

  prefix = arguments[1] if arguments[1]

  raise Puppet::ParseError, "ensure_prefix(): expected second argument to be a String, got #{prefix.inspect}" if prefix && !prefix.is_a?(String)

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

  return result
end