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

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/upcase.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/upcase.rb
index 0226a885c..de0797039 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/upcase.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/upcase.rb
@@ -1,34 +1,36 @@
 #
-# upcase.rb
+#  upcase.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(:upcase, :type => :rvalue, :doc => <<-EOS
-Converts a string or an array of strings to uppercase.
+  newfunction(:upcase, :type => :rvalue, :doc => <<-DOC
+    @summary
+      Converts a string or an array of strings to uppercase.
 
-*Examples:*
+    @return
+      converted string ot array of strings to uppercase
 
-    upcase("abcd")
+    @example **Usage**
 
-Will return:
+      upcase("abcd")
+      Will return ABCD
 
-    ASDF
-  EOS
-  ) do |arguments|
+    > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core
+    will be used instead of this function.
+  DOC
+             ) do |arguments|
 
-    raise(Puppet::ParseError, "upcase(): Wrong number of arguments " +
-                                "given (#{arguments.size} for 1)") if arguments.size != 1
+    raise(Puppet::ParseError, "upcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1
 
     value = arguments[0]
 
     unless value.is_a?(Array) || value.is_a?(Hash) || value.respond_to?(:upcase)
-      raise(Puppet::ParseError, 'upcase(): Requires an ' +
-                                  'array, hash or object that responds to upcase in order to work')
+      raise(Puppet::ParseError, 'upcase(): Requires an array, hash or object that responds to upcase in order to work')
     end
 
     if value.is_a?(Array)
       # Numbers in Puppet are often string-encoded which is troublesome ...
-      result = value.collect { |i| function_upcase([i]) }
+      result = value.map { |i| function_upcase([i]) }
     elsif value.is_a?(Hash)
       result = {}
       value.each_pair do |k, v|