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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/downcase.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/downcase.rb
index 040b84f56..a0717ff61 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/downcase.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/downcase.rb
@@ -1,29 +1,37 @@
 #
 #  downcase.rb
+#  Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085.
 #
-
 module Puppet::Parser::Functions
-  newfunction(:downcase, :type => :rvalue, :doc => <<-EOS
-Converts the case of a string or all strings in an array to lower case.
-    EOS
-  ) do |arguments|
+  newfunction(:downcase, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated:** Converts the case of a string or all strings in an array to lower case.
+
+    > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a
+    built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function.
+    >
+    This function is an implementation of a Ruby class and might not be UTF8 compatible.
+    To ensure compatibility, use this function with Ruby 2.4.0 or greater.
 
-    raise(Puppet::ParseError, "downcase(): Wrong number of arguments " +
-      "given (#{arguments.size} for 1)") if arguments.size < 1
+    @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, "downcase(): 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, 'downcase(): Requires either ' +
-        'array or string to work with')
+      raise(Puppet::ParseError, 'downcase(): 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.downcase : i }
-    else
-      result = value.downcase
-    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.downcase : i }
+             else
+               value.downcase
+             end
 
     return result
   end