Puppet Function: deep_merge

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

Summary

Recursively merges two or more hashes together and returns the resulting hash.

Overview

deep_merge() ⇒ Hash

Examples:

Example usage


$hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
$hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
$merged_hash = deep_merge($hash1, $hash2)

The resulting hash is equivalent to:

$merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } }

When there is a duplicate key that is a hash, they are recursively merged.
When there is a duplicate key that is not a hash, the key in the rightmost hash will "win."

Returns:

  • (Hash) —

    The merged h



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

newfunction(:deep_merge, type: :rvalue, doc: <<-'DOC') do |args|
  @summary
    Recursively merges two or more hashes together and returns the resulting hash.

  @example Example usage

    $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
    $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
    $merged_hash = deep_merge($hash1, $hash2)

    The resulting hash is equivalent to:

    $merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } }

    When there is a duplicate key that is a hash, they are recursively merged.
    When there is a duplicate key that is not a hash, the key in the rightmost hash will "win."

  @return [Hash] The merged hash
  DOC

  if args.length < 2
    raise Puppet::ParseError, "deep_merge(): wrong number of arguments (#{args.length}; must be at least 2)"
  end

  deep_merge = proc do |hash1, hash2|
    hash1.merge(hash2) do |_key, old_value, new_value|
      if old_value.is_a?(Hash) && new_value.is_a?(Hash)
        deep_merge.call(old_value, new_value)
      else
        new_value
      end
    end
  end

  result = {}
  args.each do |arg|
    next if arg.is_a?(String) && arg.empty? # empty string is synonym for puppet's undef
    # If the argument was not a hash, skip it.
    unless arg.is_a?(Hash)
      raise Puppet::ParseError, "deep_merge: unexpected argument type #{arg.class}, only expects hash arguments"
    end

    result = deep_merge.call(result, arg)
  end
  return(result)
end