Puppet Function: lstrip

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

Summary

**Deprecated:** Strips leading spaces to the left of a string.

Overview

lstrip() ⇒ String

> *Note:* *Deprecated* from Puppet 6.0.0, this function has been replaced with a built-in [`lstrip`](puppet.com/docs/puppet/latest/function.html#lstrip) function.

Returns:

  • (String) —

    The stripped string



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

newfunction(:lstrip, type: :rvalue, doc: <<-DOC
  @summary
    **Deprecated:** Strips leading spaces to the left of a string.

  @return [String]
    The stripped string

  > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a
  built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) function.
  DOC
) do |arguments|
  raise(Puppet::ParseError, "lstrip(): 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, 'lstrip(): 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.lstrip : i }
           else
             value.lstrip
           end

  return result
end