Update puppetlabs/stdlib module
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / is_bool.rb
1 #
2 # is_bool.rb
3 #
4 module Puppet::Parser::Functions
5   newfunction(:is_bool, :type => :rvalue, :doc => <<-DOC
6     Returns true if the variable passed to this function is a boolean.
7     DOC
8              ) do |arguments|
9
10     function_deprecation([:is_bool, 'This method is deprecated, please use the stdlib validate_legacy function,
11                           with Stdlib::Compat::Bool. There is further documentation for validate_legacy function in the README.'])
12
13     raise(Puppet::ParseError, "is_bool(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size != 1
14
15     type = arguments[0]
16
17     result = type.is_a?(TrueClass) || type.is_a?(FalseClass)
18
19     return result
20   end
21 end