Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / is_integer.rb
index 8965b15..a86b5cd 100644 (file)
@@ -1,21 +1,29 @@
 #
 # is_integer.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:is_integer, :type => :rvalue, :doc => <<-EOS
-Returns true if the variable passed to this function is an Integer or
-a decimal (base 10) integer in String form. The string may
-start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not
-be followed by other digits as this indicates that the value is octal (base 8).
+  newfunction(:is_integer, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated:** Returns true if the variable passed to this function is an Integer or
+      a decimal (base 10) integer in String form.
+
+    The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0'
+    digit may not be followed by other digits as this indicates that the value is octal (base 8).
+
+    If given any other argument `false` is returned.
 
-If given any other argument `false` is returned.
-    EOS
-  ) do |arguments|
+    @return [Boolean]
+      Returns `true` or `false`
 
-    function_deprecation([:is_integer, 'This method is deprecated, please use the stdlib validate_legacy function, with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.'])
+    > **Note:* **Deprecated** Will be removed in a future version of stdlib. See
+    [`validate_legacy`](#validate_legacy).
+    DOC
+             ) do |arguments|
 
-    if (arguments.size != 1) then
+    function_deprecation([:is_integer, 'This method is deprecated, please use the stdlib validate_legacy function,
+                            with Stdlib::Compat::Integer. There is further documentation for validate_legacy function in the README.'])
+
+    if arguments.size != 1
       raise(Puppet::ParseError, "is_integer(): Wrong number of arguments given #{arguments.size} for 1")
     end
 
@@ -35,11 +43,8 @@ If given any other argument `false` is returned.
     # 47291
     numeric = %r{^-?(?:(?:[1-9]\d*)|0)$}
 
-    if value.is_a? Integer or (value.is_a? String and value.match numeric)
-      return true
-    else
-      return false
-    end
+    return true if value.is_a?(Integer) || (value.is_a?(String) && value.match(numeric))
+    return false
   end
 end