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     @summary
   7       **Deprecated:** Returns true if the variable passed to this function is a string.
   8
   9     @return [Boolean]
  10       Returns `true` or `false`
  11
  12     > **Note:* **Deprecated** Will be removed in a future version of stdlib. See
  13     [`validate_legacy`](#validate_legacy).
  14     DOC
  15              ) do |arguments|
  16
  17     function_deprecation([:is_string, 'This method is deprecated, please use the stdlib validate_legacy function,
  18                           with Stdlib::Compat::String. There is further documentation for validate_legacy function in the README.'])
  19
  20     raise(Puppet::ParseError, "is_string(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
  21
  22     type = arguments[0]
  23
  24     # when called through the v4 API shim, undef gets translated to nil
  25     result = type.is_a?(String) || type.nil?
  26
  27     if result && (type == type.to_f.to_s || type == type.to_i.to_s)
  28       return false
  29     end
  30
  31     return result
  32   end
  33 end
  34
  35 # vim: set ts=2 sw=2 et :