Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / is_ip_address.rb
index a90adab..61f84a1 100644 (file)
@@ -1,18 +1,26 @@
 #
 # is_ip_address.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:is_ip_address, :type => :rvalue, :doc => <<-EOS
-Returns true if the string passed to this function is a valid IP address.
-    EOS
-  ) do |arguments|
+  newfunction(:is_ip_address, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated:** Returns true if the string passed to this function is a valid IP address.
+
+    @return [Boolean]
+      Returns `true` or `false`
+
+    > **Note:* **Deprecated** Will be removed in a future version of stdlib. See
+    [`validate_legacy`](#validate_legacy).
+    DOC
+             ) do |arguments|
 
     require 'ipaddr'
 
-    if (arguments.size != 1) then
-      raise(Puppet::ParseError, "is_ip_address(): Wrong number of arguments "+
-        "given #{arguments.size} for 1")
+    function_deprecation([:is_ip_address, 'This method is deprecated, please use the stdlib validate_legacy function,
+                           with Stdlib::Compat::Ip_address. There is further documentation for validate_legacy function in the README.'])
+
+    if arguments.size != 1
+      raise(Puppet::ParseError, "is_ip_address(): Wrong number of arguments given #{arguments.size} for 1")
     end
 
     begin
@@ -21,11 +29,8 @@ Returns true if the string passed to this function is a valid IP address.
       return false
     end
 
-    if ip.ipv4? or ip.ipv6? then
-      return true
-    else
-      return false
-    end
+    return true if ip.ipv4? || ip.ipv6?
+    return false
   end
 end