Puppet Function: str2bool

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

Summary

This converts a string to a boolean.

Overview

str2bool() ⇒ Any

> Note: that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. See the function new() in Puppet for details what the Boolean data type supports.

Returns:

  • (Any) —

    This attempt to convert to boolean 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'.



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

newfunction(:str2bool, type: :rvalue, doc: <<-DOC
  @summary
    This converts a string to a boolean.

  @return
    This attempt to convert to boolean 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'.

  > *Note:* that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value.
  See the function new() in Puppet for details what the Boolean data type supports.
DOC
) do |arguments|
  raise(Puppet::ParseError, "str2bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?

  string = arguments[0]

  # If string is already Boolean, return it
  if !!string == string # rubocop:disable Style/DoubleNegation : No viable alternative
    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 %r{^$}, '' then false # Empty string will be false ...
           when %r{^(1|t|y|true|yes)$}i  then true
           when %r{^(0|f|n|false|no)$}i  then false
           when %r{^(undef|undefined)$} then false # This is not likely to happen ...
           else
             raise(Puppet::ParseError, 'str2bool(): Unknown type of boolean given')
           end

  return result
end