X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fis_ip_address.rb;h=61f84a13e363595471dfbb629cc97aa2953df28e;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=a90adabe15acd94d98cfe37ba18859f72db16496;hpb=ad88f67c13ae0f1a08936dad643f1e3509ab5f40;p=mirror%2Fdsa-puppet.git diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_ip_address.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_ip_address.rb index a90adabe1..61f84a13e 100644 --- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_ip_address.rb +++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_ip_address.rb @@ -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