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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/chomp.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/chomp.rb
index c55841e3c..c917d580a 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/chomp.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/chomp.rb
@@ -1,31 +1,37 @@
 #
 #  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]
 
     unless value.is_a?(Array) || value.is_a?(String)
-      raise(Puppet::ParseError, 'chomp(): Requires either ' +
-        'array or string to work with')
+      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