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

   1 #
   2 #  chomp.rb
   3 #
   4 module Puppet::Parser::Functions
   5   newfunction(:chomp, :type => :rvalue, :doc => <<-DOC
   6     @summary
   7       **Deprecated** Removes the record separator from the end of a string or an array of strings.
   8
   9     For example `hello\n` becomes `hello`.
  10     Requires a single string or array as an input.
  11
  12     > *Note:*
  13       **Deprecated** from Puppet 6.0.0, this function has been replaced with a
  14     built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) function.
  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, "chomp(): 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, 'chomp(): 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.chomp : i }
  32              else
  33                value.chomp
  34              end
  35
  36     return result
  37   end
  38 end
  39
  40 # vim: set ts=2 sw=2 et :