Puppet Function: str2bool

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

Overview

str2bool() ⇒ Any

This converts a string to a boolean. This attempt to convert strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things like: 0, F,f, N,n, false, FALSE, no to 'false'.

Returns:

  • (Any) 


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

newfunction(:str2bool, :type => :rvalue, :doc => <<-EOS
This converts a string to a boolean. This attempt to convert strings that
contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things
like: 0, F,f, N,n, false, FALSE, no to 'false'.
  EOS
) do |arguments|

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

  string = arguments[0]

  # If string is already Boolean, return it
  if !!string == string
    return string
  end

  unless string.is_a?(String)
    raise(Puppet::ParseError, 'str2bool(): Requires ' +
      '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 /^$/, '' then false # Empty string will be false ...
    when /^(1|t|y|true|yes)$/i  then true
    when /^(0|f|n|false|no)$/i  then false
    when /^(undef|undefined)$/ then false # This is not likely to happen ...
    else
      raise(Puppet::ParseError, 'str2bool(): Unknown type of boolean given')
  end

  return result
end