3rdparty/modules/stdlib/lib/puppet/parser/functions/is_float.rb

   1 #
   2 # is_float.rb
   3 #
   4 module Puppet::Parser::Functions
   5   newfunction(:is_float, :type => :rvalue, :doc => <<-DOC
   6     @summary
   7       **Deprecated:** Returns true if the variable passed to this function is a float.
   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_float, 'This method is deprecated, please use the stdlib validate_legacy function,
  18                           with Stdlib::Compat::Float. There is further documentation for validate_legacy function in the README.'])
  19
  20     if arguments.size != 1
  21       raise(Puppet::ParseError, "is_float(): Wrong number of arguments given #{arguments.size} for 1")
  22     end
  23
  24     value = arguments[0]
  25
  26     # Only allow Numeric or String types
  27     return false unless value.is_a?(Numeric) || value.is_a?(String)
  28
  29     return false if value != value.to_f.to_s && !value.is_a?(Float)
  30     return true
  31   end
  32 end
  33
  34 # vim: set ts=2 sw=2 et :