Puppet Function: hash

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

Summary

**Deprecated:** This function converts an array into a hash.

Overview

hash() ⇒ Any

> *Note:* This function has been replaced with the built-in ability to create a new value of almost any data type - see the built-in [`Hash.new`](puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function in Puppet. This example shows the equivalent expression in the Puppet language:

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

Examples:

Example Usage:

hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3}

Returns:

  • (Any) —

    the converted array as a hash



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

newfunction(:hash, type: :rvalue, doc: <<-DOC
  @summary
    **Deprecated:** This function converts an array into a hash.

  @return
    the converted array as a hash
  @example Example Usage:
    hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3}

  > **Note:** This function has been replaced with the built-in ability to create a new value of almost any
  data type - see the built-in [`Hash.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-hash-and-struct) function
  in Puppet.
  This example shows the equivalent expression in the Puppet language:
    ```
    Hash(['a',1,'b',2,'c',3])
    Hash([['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