Puppet Function: bool2str

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

Summary

Converts a boolean to a string using optionally supplied arguments.

Overview

bool2str() ⇒ Any

The optional second and third arguments represent what true and false will be converted to respectively. If only one argument is given, it will be converted from a boolean to a string containing 'true' or 'false'.

**Examples of usage**

```
  bool2str(true)                    => 'true'
  bool2str(true, 'yes', 'no')       => 'yes'
  bool2str(false, 't', 'f')         => 'f'
```

Requires a single boolean as an input.

> Note:

since Puppet 5.0.0 it is possible to create new data types for almost any
datatype using the type system and the built-in
[`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string)
function is used to convert to String with many different format options.

```
  notice(String(false))         # Notices 'false'
  notice(String(true))          # Notices 'true'
  notice(String(false, '%y'))   # Notices 'yes'
  notice(String(true, '%y'))    # Notices 'no'
```

Returns:

  • (Any) —

    The converted value to string of the given Boolean



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
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'vendor_modules/stdlib/lib/puppet/parser/functions/bool2str.rb', line 7

newfunction(:bool2str, type: :rvalue, doc: <<-DOC
  @summary
    Converts a boolean to a string using optionally supplied arguments.

  The optional second and third arguments represent what true and false will be
  converted to respectively. If only one argument is given, it will be
  converted from a boolean to a string containing 'true' or 'false'.

  @return
    The converted value to string of the given Boolean

  **Examples of usage**

    ```
      bool2str(true)                    => 'true'
      bool2str(true, 'yes', 'no')       => 'yes'
      bool2str(false, 't', 'f')         => 'f'
    ```

  Requires a single boolean as an input.

  > *Note:*
    since Puppet 5.0.0 it is possible to create new data types for almost any
    datatype using the type system and the built-in
    [`String.new`](https://puppet.com/docs/puppet/latest/function.html#boolean-to-string)
    function is used to convert to String with many different format options.

    ```
      notice(String(false))         # Notices 'false'
      notice(String(true))          # Notices 'true'
      notice(String(false, '%y'))   # Notices 'yes'
      notice(String(true, '%y'))    # Notices 'no'
    ```
  DOC
) do |arguments|
  unless arguments.size == 1 || arguments.size == 3
    raise(Puppet::ParseError, "bool2str(): Wrong number of arguments given (#{arguments.size} for 3)")
  end

  value = arguments[0]
  true_string = arguments[1] || 'true'
  false_string = arguments[2] || 'false'
  klass = value.class

  # We can have either true or false, and nothing else
  unless [FalseClass, TrueClass].include?(klass)
    raise(Puppet::ParseError, 'bool2str(): Requires a boolean to work with')
  end

  unless [true_string, false_string].all? { |x| x.is_a?(String) }
    raise(Puppet::ParseError, 'bool2str(): Requires strings to convert to')
  end

  return value ? true_string : false_string
end