Puppet Function: rstrip

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

Summary

Strips leading spaces to the right of the string.

Overview

rstrip() ⇒ Any

> Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function.

Returns:

  • (Any) —

    the string with leading spaces removed



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 'lib/puppet/parser/functions/rstrip.rb', line 7

newfunction(:rstrip, type: :rvalue, doc: <<-DOC
  @summary
    Strips leading spaces to the right of the string.

  @return
    the string with leading spaces removed

  > *Note:* from Puppet 6.0.0, the compatible function with the same name in Puppet core
  will be used instead of this function.
  DOC
) do |arguments|
  raise(Puppet::ParseError, "rstrip(): 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, 'rstrip(): Requires either array or string to work with')
  end

  result = if value.is_a?(Array)
             value.map { |i| i.is_a?(String) ? i.rstrip : i }
           else
             value.rstrip
           end

  return result
end