#
# lstrip.rb
#
-
module Puppet::Parser::Functions
- newfunction(:lstrip, :type => :rvalue, :doc => <<-EOS
-Strips leading spaces to the left of a string.
- EOS
- ) do |arguments|
+ newfunction(:lstrip, :type => :rvalue, :doc => <<-DOC
+ @summary
+ **Deprecated:** Strips leading spaces to the left of a string.
+
+ @return [String]
+ The stripped string
- raise(Puppet::ParseError, "lstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1
+ > **Note:** **Deprecated** from Puppet 6.0.0, this function has been replaced with a
+ built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) function.
+ DOC
+ ) do |arguments|
+
+ raise(Puppet::ParseError, "lstrip(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
value = arguments[0]
raise(Puppet::ParseError, 'lstrip(): Requires either 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.lstrip : i }
- else
- result = value.lstrip
- 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