#
-# 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|