Puppet Function: is_integer

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

Overview

is_integer()Boolean

The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not be followed by other digits as this indicates that the value is octal (base 8).

If given any other argument `false` is returned.

> *Note: *Deprecated* Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy).

Returns:

  • (Boolean)

    Returns `true` or `false`



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
41
42
43
44
45
46
47
48
# File 'modules/stdlib/lib/puppet/parser/functions/is_integer.rb', line 5

newfunction(:is_integer, :type => :rvalue, :doc => <<-DOC
  @summary
    **Deprecated:** Returns true if the variable passed to this function is an Integer or
    a decimal (base 10) integer in String form.

  The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0'
  digit may not be followed by other digits as this indicates that the value is octal (base 8).

  If given any other argument `false` is returned.

  @return [Boolean]
    Returns `true` or `false`

  > **Note:* **Deprecated** Will be removed in a future version of stdlib. See
  [`validate_legacy`](#validate_legacy).
  DOC
           ) do |arguments|

  function_deprecation([:is_integer, 'This method is deprecated, please use the stdlib validate_legacy function,
                          with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.'])

  if arguments.size != 1
    raise(Puppet::ParseError, "is_integer(): Wrong number of arguments given #{arguments.size} for 1")
  end

  value = arguments[0]

  # Regex is taken from the lexer of puppet
  # puppet/pops/parser/lexer.rb but modified to match also
  # negative values and disallow numbers prefixed with multiple
  # 0's
  #
  # TODO these parameter should be a constant but I'm not sure
  # if there is no risk to declare it inside of the module
  # Puppet::Parser::Functions

  # Integer numbers like
  # -1234568981273
  # 47291
  numeric = %r{^-?(?:(?:[1-9]\d*)|0)$}

  return true if value.is_a?(Integer) || (value.is_a?(String) && value.match(numeric))
  return false
end