Puppet Function: downcase

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

Overview

downcase()String, Array[String]

> Note: *Deprecated* from Puppet 6.0.0, this function has been replaced with a built-in [`downcase`](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.

Returns:

  • (String)

    The converted String, if it was a String that was given

  • (Array[String])

    The converted Array, if it was a Array that was given



6
7
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
# File 'modules/stdlib/lib/puppet/parser/functions/downcase.rb', line 6

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.

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