#
# bool2num.rb
#
-
module Puppet::Parser::Functions
- newfunction(:bool2num, :type => :rvalue, :doc => <<-EOS
- Converts a boolean to a number. Converts the values:
+ newfunction(:bool2num, :type => :rvalue, :doc => <<-DOC
+ @summary
+ Converts a boolean to a number.
+
+ Converts the values:
+ ```
false, f, 0, n, and no to 0
true, t, 1, y, and yes to 1
+ ```
Requires a single boolean or string as an input.
- EOS
- ) do |arguments|
- raise(Puppet::ParseError, "bool2num(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1
+ > *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
+ [`Numeric.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-numeric),
+ [`Integer.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-integer), and
+ [`Float.new`](https://puppet.com/docs/puppet/latest/function.html#conversion-to-float)
+ function are used to convert to numeric values.
+ ```
+ notice(Integer(false)) # Notices 0
+ notice(Float(true)) # Notices 1.0
+ ```
+
+ @return [Integer] The converted value as a number
+ DOC
+ ) do |arguments|
+
+ raise(Puppet::ParseError, "bool2num(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
value = function_str2bool([arguments[0]])