Puppet Function: strip

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

Overview

strip()Any

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

Examples:

*Usage*


strip("    aaa   ")
Would result in: "aaa"

Returns:

  • (Any)

    String or Array converted



5
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
36
37
38
# File 'modules/stdlib/lib/puppet/parser/functions/strip.rb', line 5

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

  @return
    String or Array converted

  @example **Usage**

    strip("    aaa   ")
    Would result in: "aaa"

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

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

  return result
end