Puppet Function: upcase

Defined in:
vendor_modules/stdlib/lib/puppet/parser/functions/upcase.rb
Function type:
Ruby 3.x API

Summary

Converts a string or an array of strings to uppercase.

Overview

upcase() ⇒ Any

> Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function.

Examples:

*Usage*


upcase("abcd")
Will return ABCD

Returns:

  • (Any) —

    converted string ot array of strings to uppercase



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/upcase.rb', line 8

newfunction(:upcase, type: :rvalue, doc: <<-DOC
  @summary
    Converts a string or an array of strings to uppercase.

  @return
    converted string ot array of strings to uppercase

  @example **Usage**

    upcase("abcd")
    Will return ABCD

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

  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')
  end

  if value.is_a?(Array)
    # Numbers in Puppet are often string-encoded which is troublesome ...
    result = value.map { |i| function_upcase([i]) }
  elsif value.is_a?(Hash)
    result = {}
    value.each_pair do |k, v|
      result[function_upcase([k])] = function_upcase([v])
    end
  else
    result = value.upcase
  end

  return result
end