Puppet Function: chop

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

Overview

chop()Any

Returns a new string with the last character removed. If the string ends with `rn`, both characters are removed. Applying chop to an empty string returns an empty string. If you wish to merely remove record separators then you should use the `chomp` function. Requires a string or array of strings as input.

Returns:

  • (Any)


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

newfunction(:chop, :type => :rvalue, :doc => <<-'EOS'
  Returns a new string with the last character removed. If the string ends
  with `\r\n`, both characters are removed. Applying chop to an empty
  string returns an empty string. If you wish to merely remove record
  separators then you should use the `chomp` function.
  Requires a string or array of strings as input.
  EOS
) do |arguments|

  raise(Puppet::ParseError, "chop(): Wrong number of arguments " +
    "given (#{arguments.size} for 1)") if arguments.size < 1

  value = arguments[0]

  unless value.is_a?(Array) || value.is_a?(String)
    raise(Puppet::ParseError, 'chop(): Requires either an ' +
      'array or string to work with')
  end

  if value.is_a?(Array)
    # Numbers in Puppet are often string-encoded which is troublesome ...
    result = value.collect { |i| i.is_a?(String) ? i.chop : i }
  else
    result = value.chop
  end

  return result
end