Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / chomp.rb
index f9da50f..c917d58 100644 (file)
@@ -1,16 +1,24 @@
 #
 #  chomp.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:chomp, :type => :rvalue, :doc => <<-'EOS'
-    Removes the record separator from the end of a string or an array of
-    strings, for example `hello\n` becomes `hello`.
+  newfunction(:chomp, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated** Removes the record separator from the end of a string or an array of strings.
+
+    For example `hello\n` becomes `hello`.
     Requires a single string or array as an input.
-    EOS
-  ) do |arguments|
 
-    raise(Puppet::ParseError, "chomp(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1
+    > *Note:*
+      **Deprecated** from Puppet 6.0.0, this function has been replaced with a
+    built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function.
+
+    @return [String] The converted String, if it was a String that was given
+    @return [Array[String]] The converted Array, if it was a Array that was given
+    DOC
+             ) do |arguments|
+
+    raise(Puppet::ParseError, "chomp(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     value = arguments[0]
 
@@ -18,12 +26,12 @@ module Puppet::Parser::Functions
       raise(Puppet::ParseError, 'chomp(): Requires either array or string to work with')
     end
 
-    if value.is_a?(Array)
-      # Numbers in Puppet are often string-encoded which is troublesome ...
-      result = value.collect { |i| i.is_a?(String) ? i.chomp : i }
-    else
-      result = value.chomp
-    end
+    result = if value.is_a?(Array)
+               # Numbers in Puppet are often string-encoded which is troublesome ...
+               value.map { |i| i.is_a?(String) ? i.chomp : i }
+             else
+               value.chomp
+             end
 
     return result
   end