Puppet Function: hash_extended

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

Overview

hash_extended() ⇒ Any

This function flattens an array and then converts this array into a hash.

Examples:

hash(<array>, [<flatten_level>])
hash(['a',{'test' => 'test'},'b',2,'c',3], 1) -returns-> {'a'=>{'test' => 'test'},'b'=>2,'c'=>3}

Would return:

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
 
# File 'lib/puppet/parser/functions/hash_extended.rb', line 6

newfunction(:hash_extended, :type => :rvalue, :doc => <<-EOS
This function flattens an array and then converts this array into a hash.

*Examples:*
  hash(<array>, [<flatten_level>])
  hash(['a',{'test' => 'test'},'b',2,'c',3], 1) -returns-> {'a'=>{'test' => 'test'},'b'=>2,'c'=>3}
  
Would return:
EOS
) do |arguments|

  raise(Puppet::ParseError, "hash(): Wrong number of arguments given (#{arguments.size} for 2)") if arguments.size < 2

  array = arguments[0]

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

  result = {}

  begin
    # This is to make it compatible with older version of Ruby ...
    if arguments[1]
      array  = array.flatten(arguments[1])
    else
      array  = array.flatten
    end

    result = Hash[*array]
  rescue StandardError
    raise(Puppet::ParseError, 'hash(): Unable to compute hash from array given')
  end

  return result
end