Update puppetlabs/stdlib module
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / is_string.rb
1 #
2 # is_string.rb
3 #
4 module Puppet::Parser::Functions
5   newfunction(:is_string, :type => :rvalue, :doc => <<-DOC
6     Returns true if the variable passed to this function is a string.
7     DOC
8              ) do |arguments|
9
10     function_deprecation([:is_string, 'This method is deprecated, please use the stdlib validate_legacy function,
11                           with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.'])
12
13     raise(Puppet::ParseError, "is_string(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
14
15     type = arguments[0]
16
17     # when called through the v4 API shim, undef gets translated to nil
18     result = type.is_a?(String) || type.nil?
19
20     if result && (type == type.to_f.to_s || type == type.to_i.to_s)
21       return false
22     end
23
24     return result
25   end
26 end
27
28 # vim: set ts=2 sw=2 et :