3rdparty/modules/stdlib/lib/puppet/parser/functions/downcase.rb

   1 #
   2 #  downcase.rb
   3 #  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.
   4 #
   5 module Puppet::Parser::Functions
   6   newfunction(:downcase, :type => :rvalue, :doc => <<-DOC
   7     @summary
   8       **Deprecated:** Converts the case of a string or all strings in an array to lower case.
   9
  10     > *Note:* **Deprecated** from Puppet 6.0.0, this function has been replaced with a
  11     built-in [`downcase`](https://puppet.com/docs/puppet/latest/function.html#downcase) function.
  12     >
  13     This function is an implementation of a Ruby class and might not be UTF8 compatible.
  14     To ensure compatibility, use this function with Ruby 2.4.0 or greater.
  15
  16     @return [String] The converted String, if it was a String that was given
  17     @return [Array[String]] The converted Array, if it was a Array that was given
  18   DOC
  19              ) do |arguments|
  20
  21     raise(Puppet::ParseError, "downcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
  22
  23     value = arguments[0]
  24
  25     unless value.is_a?(Array) || value.is_a?(String)
  26       raise(Puppet::ParseError, 'downcase(): Requires either array or string to work with')
  27     end
  28
  29     result = if value.is_a?(Array)
  30                # Numbers in Puppet are often string-encoded which is troublesome ...
  31                value.map { |i| i.is_a?(String) ? i.downcase : i }
  32              else
  33                value.downcase
  34              end
  35
  36     return result
  37   end
  38 end
  39
  40 # vim: set ts=2 sw=2 et :