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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/chop.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/chop.rb
index b24ab7856..69b5f3ffc 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/chop.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/chop.rb
@@ -1,33 +1,37 @@
 #
 #  chop.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:chop, :type => :rvalue, :doc => <<-'EOS'
-    Returns a new string with the last character removed. If the string ends
-    with `\r\n`, both characters are removed. Applying chop to an empty
-    string returns an empty string. If you wish to merely remove record
-    separators then you should use the `chomp` function.
+  newfunction(:chop, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated** Returns a new string with the last character removed.
+
+    If the string ends with `\r\n`, both characters are removed. Applying
+    chop to an empty string returns an empty string. If you wish to merely
+    remove record separators then you should use the `chomp` function.
     Requires a string or array of strings as input.
-    EOS
-  ) do |arguments|
 
-    raise(Puppet::ParseError, "chop(): 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 [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) function.
+
+    @return [String] The given String, sans the last character.
+    DOC
+             ) do |arguments|
+
+    raise(Puppet::ParseError, "chop(): 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, 'chop(): Requires either an ' +
-        'array or string to work with')
+      raise(Puppet::ParseError, 'chop(): Requires either an 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.chop : i }
-    else
-      result = value.chop
-    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.chop : i }
+             else
+               value.chop
+             end
 
     return result
   end