Puppet Function: bool2str

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

Overview

bool2str() ⇒ Any

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'.

Examples:

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

Requires a single boolean as an input.

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

newfunction(:bool2str, :type => :rvalue, :doc => <<-EOS
  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'.

  *Examples:*

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

  Requires a single boolean as an input.
  EOS
) do |arguments|

  unless arguments.size == 1 or 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.kind_of?(String)}
    raise(Puppet::ParseError, "bool2str(): Requires strings to convert to" )
  end

  return value ? true_string : false_string
end