Puppet Function: concat_merge

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

Overview

concat_merge() ⇒ Any

Merges two or more hashes together concatenating duplicate keys with array values and returns the resulting hash.

For example:

$hash1 = {'a' => [1]}
$hash2 = {'a' => [2]}
concat_merge($hash1, $hash2)
# The resulting hash is equivalent to:
# { 'a' => [1, 2] }

When there is a duplicate key that is not an array, the key in the rightmost hash will “win.”

Returns:

  • (Any) —

    String



2
3
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
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
 
# File 'lib/puppet/parser/functions/concat_merge.rb', line 2

newfunction(
  :concat_merge,
  :type => :rvalue,
  :doc => <<-'ENDHEREDOC') do |args|
  Merges two or more hashes together concatenating duplicate keys
  with array values and returns the resulting hash.

  For example:

      $hash1 = {'a' => [1]}
      $hash2 = {'a' => [2]}
      concat_merge($hash1, $hash2)
      # The resulting hash is equivalent to:
      # { 'a' => [1, 2] }

  When there is a duplicate key that is not an array, the key in
  the rightmost hash will "win."

  @return String
  ENDHEREDOC

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

  concat_merge = Proc.new do |hash1,hash2|
    hash1.merge(hash2) do |key,old_value,new_value|
      if old_value.is_a?(Array) && new_value.is_a?(Array)
        old_value + new_value
      else
        new_value
      end
    end
  end

  result = Hash.new
  args.each do |arg|
    next if arg.is_a? String and 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, "concat_merge: unexpected argument type #{arg.class}, only expects hash arguments"
    end

    result = concat_merge.call(result, arg)
  end
  result
end