Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / deep_merge.rb
index 6df32e9..bf62576 100644 (file)
@@ -1,26 +1,33 @@
+#
+# deep_merge.rb
+#
 module Puppet::Parser::Functions
-  newfunction(:deep_merge, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args|
-    Recursively merges two or more hashes together and returns the resulting hash.
+  newfunction(:deep_merge, :type => :rvalue, :doc => <<-'DOC') do |args|
+    @summary
+      Recursively merges two or more hashes together and returns the resulting hash.
 
-    For example:
+    @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 } }
+      $hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
+      $hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
+      $merged_hash = deep_merge($hash1, $hash2)
 
-    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."
+      The resulting hash is equivalent to:
 
-    ENDHEREDOC
+      $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)")
+      raise Puppet::ParseError, "deep_merge(): wrong number of arguments (#{args.length}; must be at least 2)"
     end
 
-    deep_merge = Proc.new do |hash1,hash2|
-      hash1.merge(hash2) do |key,old_value,new_value|
+    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
@@ -29,9 +36,9 @@ module Puppet::Parser::Functions
       end
     end
 
-    result = Hash.new
+    result = {}
     args.each do |arg|
-      next if arg.is_a? String and arg.empty? # empty string is synonym for puppet's undef
+      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"
@@ -39,6 +46,6 @@ module Puppet::Parser::Functions
 
       result = deep_merge.call(result, arg)
     end
-    return( result )
+    return(result)
   end
 end