Puppet Function: deep_merge_extended

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

Overview

deep_merge_extended() ⇒ Any

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

For example:

$hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
$hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
$merged_hash = deep_merge_extended($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:

  • (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
 
# File 'lib/puppet/parser/functions/deep_merge_extended.rb', line 4

newfunction(:deep_merge_extended, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args|
  Recursively merges two or more hashes together and returns the resulting hash.

  For example:

      $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
      $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
      $merged_hash = deep_merge_extended($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."

ENDHEREDOC

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

  default_opts = {:knockout_prefix => '--', :preserve_unmergeables => false,
                  :merge_hash_arrays => true, :extend_existing_arrays => true}

  # note that we give args[1] first and then args[0] into deep_merge, since DeepMerge::deep_merge will not overwrite
  # elements which exist in args[1].
  #  Example: {cdr_mysql => {'enable' => true}} :: {cdr_mysql => {'enable' => false}} results in
  #  Example-Result: {cdr_mysql => {'enable' => true}}
  #
  DeepMerge::deep_merge!(args[1], args[0], default_opts)
end