X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fprefix.rb;h=b5e96416dbed15b8797d3bd0938e92033f738365;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=ac1c58a554e29c7d01fff286321d30af49df8069;hpb=ad88f67c13ae0f1a08936dad643f1e3509ab5f40;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/prefix.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/prefix.rb
index ac1c58a55..b5e96416d 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/prefix.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/prefix.rb
@@ -1,26 +1,30 @@
 #
 # prefix.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:prefix, :type => :rvalue, :doc => <<-EOS
-This function applies a prefix to all elements in an array or a hash.
+  newfunction(:prefix, :type => :rvalue, :doc => <<-DOC
+    @summary
+      This function applies a prefix to all elements in an array or a hash.
+
+    @example **Usage**
 
-*Examples:*
+      prefix(['a','b','c'], 'p')
+      Will return: ['pa','pb','pc']
 
-    prefix(['a','b','c'], 'p')
+    > *Note:* since Puppet 4.0.0 the general way to modify values is in array is by using the map
+    function in Puppet. This example does the same as the example above:
+    ['a', 'b', 'c'].map |$x| { "p${x}" }
 
-Will return: ['pa','pb','pc']
-    EOS
-  ) do |arguments|
+    @return [Hash] or [Array] The passed values now contains the passed prefix
+    DOC
+             ) do |arguments|
 
     # Technically we support two arguments but only first is mandatory ...
-    raise(Puppet::ParseError, "prefix(): Wrong number of arguments " +
-      "given (#{arguments.size} for 1)") if arguments.size < 1
+    raise(Puppet::ParseError, "prefix(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     enumerable = arguments[0]
 
-    unless enumerable.is_a?(Array) or enumerable.is_a?(Hash)
+    unless enumerable.is_a?(Array) || enumerable.is_a?(Hash)
       raise Puppet::ParseError, "prefix(): expected first argument to be an Array or a Hash, got #{enumerable.inspect}"
     end
 
@@ -32,18 +36,18 @@ Will return: ['pa','pb','pc']
       end
     end
 
-    if enumerable.is_a?(Array)
-      # Turn everything into string same as join would do ...
-      result = enumerable.collect do |i|
-        i = i.to_s
-        prefix ? prefix + i : i
-      end
-    else
-      result = Hash[enumerable.map do |k,v|
-        k = k.to_s
-        [ prefix ? prefix + k : k, v ]
-      end]
-    end
+    result = if enumerable.is_a?(Array)
+               # Turn everything into string same as join would do ...
+               enumerable.map do |i|
+                 i = i.to_s
+                 prefix ? prefix + i : i
+               end
+             else
+               Hash[enumerable.map do |k, v|
+                 k = k.to_s
+                 [prefix ? prefix + k : k, v]
+               end]
+             end
 
     return result
   end