Puppet Function: hash

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

Overview

hash()Any

This function converts an array into a hash.

Examples:

hash(['a',1,'b',2,'c',3])

Would return: 'a'=>1,'b'=>2,'c'=>3

Returns:

  • (Any)


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
# File 'modules/stdlib/lib/puppet/parser/functions/hash.rb', line 5

newfunction(:hash, :type => :rvalue, :doc => <<-DOC
  This function converts an array into a hash.

  *Examples:*

      hash(['a',1,'b',2,'c',3])

  Would return: {'a'=>1,'b'=>2,'c'=>3}
  DOC
           ) do |arguments|

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

  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 ...
    array  = array.flatten
    result = Hash[*array]
  rescue StandardError
    raise(Puppet::ParseError, 'hash(): Unable to compute hash from array given')
  end

  return result
end