Puppet Function: any2bool

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

Overview

any2bool() ⇒ Any

This converts any input to a boolean. This attempt to convert strings that contain things like: y, 1, t, true to ‘true’ and strings that contain things like: 0, f, n, false, no to ‘false’.

Returns:

  • (Any) 


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

newfunction(:any2bool, :type => :rvalue, :doc => <<-EOS
This converts any input to a boolean. This attempt to convert strings that 
contain things like: y, 1, t, true to 'true' and strings that contain things
like: 0, f, n, false, no to 'false'.
  EOS
) do |arguments|

  raise(Puppet::ParseError, "any2bool(): Wrong number of arguments " +
    "given (#{arguments.size} for 1)") if arguments.size < 1

  string = arguments[0]

#    unless string.is_a?(String)
#      raise(Puppet::ParseError, 'str2bool(): Requires either ' +
#        'string to work with')
#    end

  # We consider all the yes, no, y, n and so on too ...
  result = case string
    #
    # This is how undef looks like in Puppet ...
    # We yield false in this case.
    #
    when false then false
    when true then true
    when /^$/, '' then false # Empty string will be false ...
    when /^(1|t|y|true|yes)$/  then true
    when /^(0|f|n|false|no)$/  then false
    when /^(undef|undefined)$/ then false # This is not likely to happen ...
    else
      raise(Puppet::ParseError, 'any2bool(): Unknown type of boolean given')
  end

  return result
end