summaryrefslogtreecommitdiff
path: root/code/environments/production/modules/stdlib/lib/puppet/parser/functions/is_string.rb
blob: f7b1b145b4fed3cb3dffb49ee20cd5b523344384 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
#
# is_string.rb
#
module Puppet::Parser::Functions
  newfunction(:is_string, :type => :rvalue, :doc => <<-DOC
    Returns true if the variable passed to this function is a string.
    DOC
             ) do |arguments|

    function_deprecation([:is_string, 'This method is deprecated, please use the stdlib validate_legacy function,
                          with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.'])

    raise(Puppet::ParseError, "is_string(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?

    type = arguments[0]

    # when called through the v4 API shim, undef gets translated to nil
    result = type.is_a?(String) || type.nil?

    if result && (type == type.to_f.to_s || type == type.to_i.to_s)
      return false
    end

    return result
  end
end

# vim: set ts=2 sw=2 et :