Puppet Function: chomp

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

Overview

chomp()Any

Removes the record separator from the end of a string or an array of strings, for example `hellon` becomes `hello`. Requires a single string or array as an input.

Returns:

  • (Any)


5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
# File 'modules/stdlib/lib/puppet/parser/functions/chomp.rb', line 5

newfunction(:chomp, :type => :rvalue, :doc => <<-DOC
  Removes the record separator from the end of a string or an array of
  strings, for example `hello\n` becomes `hello`.
  Requires a single string or array as an input.
  DOC
           ) do |arguments|

  raise(Puppet::ParseError, "chomp(): 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, 'chomp(): 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.chomp : i }
           else
             value.chomp
           end

  return result
end