Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / empty.rb
index 4f77ad3..907ecb1 100644 (file)
@@ -1,28 +1,30 @@
 #
 # empty.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:empty, :type => :rvalue, :doc => <<-EOS
-Returns true if the variable is empty.
-    EOS
-  ) do |arguments|
+  newfunction(:empty, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated:** Returns true if the variable is empty.
+
+    @return
+      Returns `true` if the argument is an array or hash that contains no elements,
+      or an empty string. Returns `false` when the argument is a numerical value.
 
-    raise(Puppet::ParseError, "empty(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.size < 1
+    > *Note*: **Deprecated** from Puppet 5.5.0, the built-in
+    [`empty`](https://puppet.com/docs/puppet/6.4/function.html#empty) function will be used instead.
+  DOC
+             ) do |arguments|
 
+    raise(Puppet::ParseError, "empty(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
     value = arguments[0]
 
     unless value.is_a?(Array) || value.is_a?(Hash) || value.is_a?(String) || value.is_a?(Numeric)
       raise(Puppet::ParseError, 'empty(): Requires either array, hash, string or integer to work with')
     end
 
-    if value.is_a?(Numeric)
-      return false
-    else
-      result = value.empty?
-
-      return result
-    end
+    return false if value.is_a?(Numeric)
+    result = value.empty?
+    return result
   end
 end