Puppet Function: abs

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

Overview

abs()Any

For example -34.56 becomes 34.56. Takes a single integer or float value as an argument.

> Note:

**Deprected** from Puppet 6.0.0, the built-in
['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead.

Returns:

  • (Any)

    The absolute value of the given number if it was an Integer



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

newfunction(:abs, :type => :rvalue, :doc => <<-DOC
  @summary
    **Deprecated:** Returns the absolute value of a number

  For example -34.56 becomes 34.56.
  Takes a single integer or float value as an argument.

  > *Note:*
    **Deprected** from Puppet 6.0.0, the built-in
    ['abs'](https://puppet.com/docs/puppet/6.4/function.html#abs)function will be used instead.

  @return The absolute value of the given number if it was an Integer

  DOC
           ) do |arguments|

  raise(Puppet::ParseError, "abs(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?

  value = arguments[0]

  # Numbers in Puppet are often string-encoded which is troublesome ...
  if value.is_a?(String)
    if value =~ %r{^-?(?:\d+)(?:\.\d+){1}$}
      value = value.to_f
    elsif value =~ %r{^-?\d+$}
      value = value.to_i
    else
      raise(Puppet::ParseError, 'abs(): Requires float or integer to work with')
    end
  end

  # We have numeric value to handle ...
  result = value.abs

  return result
end