Puppet Function: max

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

Overview

max()Any

Requires at least one argument.

> *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:

  • (Any)

    The highest value among those passed in



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

newfunction(:max, :type => :rvalue, :doc => <<-DOC
  @summary
    **Deprecated:** Returns the highest value of all arguments.

  Requires at least one argument.

  @return
    The highest value among those passed in

  > **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 |args|

  raise(Puppet::ParseError, 'max(): Wrong number of arguments need at least one') if args.empty?

  # Sometimes we get numbers as numerics and sometimes as strings.
  # We try to compare them as numbers when possible
  return args.max do |a, b|
    if a.to_s =~ %r{\A-?\d+(.\d+)?\z} && b.to_s =~ %r{\A-?\d+(.\d+)?\z}
      a.to_f <=> b.to_f
    else
      a.to_s <=> b.to_s
    end
  end
end