Handle array values in join_keys_to_values function

Author: edestecd

README.markdown

@@ -716,7 +716,9 @@ Joins an array into a string using a separator. For example, `join(['a','b','c']
 
 #### `join_keys_to_values`
 
-Joins each key of a hash to that key's corresponding value with a separator. Keys and values are cast to strings. The return value is an array in which each element is one joined key/value pair. For example, `join_keys_to_values({'a'=>1,'b'=>2}, " is ")` results in ["a is 1","b is 2"]. *Type*: rvalue.
+Joins each key of a hash to that key's corresponding value with a separator. Keys are cast to strings.
+If values are arrays, multiple keys are added for each element.
+The return value is an array in which each element is one joined key/value pair. For example, `join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")` results in ["a is 1","b is 2","b is 3"]. *Type*: rvalue.
 
 #### `keys`
 

lib/puppet/parser/functions/join_keys_to_values.rb

@@ -5,14 +5,19 @@
 module Puppet::Parser::Functions
   newfunction(:join_keys_to_values, :type => :rvalue, :doc => <<-EOS
 This function joins each key of a hash to that key's corresponding value with a
-separator. Keys and values are cast to strings. The return value is an array in
+separator. Keys are cast to strings. If values are arrays, multiple keys
+are added for each element. The return value is an array in
 which each element is one joined key/value pair.
 
 *Examples:*
 
     join_keys_to_values({'a'=>1,'b'=>2}, " is ")
 
 Would result in: ["a is 1","b is 2"]
+
+    join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ")
+
+Would result in: ["a is 1","b is 2","b is 3"]
     EOS
   ) do |arguments|
 
@@ -38,8 +43,12 @@ module Puppet::Parser::Functions
 
     # Join the keys to their values.
     hash.map do |k,v|
-      String(k) + separator + String(v)
-    end
+      if v.is_a?(Array)
+        v.map { |va| String(k) + separator + String(va) }
+      else
+        String(k) + separator + String(v)
+      end
+    end.flatten
 
   end
 end

spec/functions/join_keys_to_values_spec.rb

@@ -16,4 +16,8 @@
     result = subject.call([{ 'key1' => 'value1', 'key2' => 'value2' }, ':'])
     expect(result.sort).to eq(['key1:value1', 'key2:value2'].sort)
   end
+  it 'should run join_keys_to_values(<hash with array value>, " ") and return the proper array' do
+    result = subject.call([{ 'key1' => 'value1', 'key2' => ['value2', 'value3'] }, ' '])
+    expect(result.sort).to eq(['key1 value1', 'key2 value2', 'key2 value3'].sort)
+  end
 end