Puppet Function: strip

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

Overview

strip() ⇒ Any

This function removes leading and trailing whitespace from a string or from every string inside an array.

Examples:

strip("    aaa   ")

Would result in: “aaa”

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

newfunction(:strip, :type => :rvalue, :doc => <<-EOS
This function removes leading and trailing whitespace from a string or from
every string inside an array.

*Examples:*

  strip("    aaa   ")

Would result in: "aaa"
  EOS
) do |arguments|

  raise(Puppet::ParseError, "strip(): 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, 'strip(): Requires either ' +
      'array or string to work with')
  end

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

  return result
end