Update stdlib and concat to 6.1.0 both

[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / is_email_address.rb

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_email_address.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_email_address.rb
index bcd7921..1c41b86 100644 (file)
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_email_address.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/is_email_address.rb
@@ -1,11 +1,17 @@
 #
 # is_email_address.rb
 #
-
 module Puppet::Parser::Functions
-  newfunction(:is_email_address, :type => :rvalue, :doc => <<-EOS
-Returns true if the string passed to this function is a valid email address.
-    EOS
+  newfunction(:is_email_address, :type => :rvalue, :doc => <<-DOC
+    @summary
+      **Deprecated:** Returns true if the string passed to this function is a valid email 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|
     if arguments.size != 1
       raise(Puppet::ParseError, "is_email_address(): Wrong number of arguments given #{arguments.size} for 1")
@@ -13,7 +19,7 @@ Returns true if the string passed to this function is a valid email address.
 
     # Taken from http://emailregex.com/ (simpler regex)
     valid_email_regex = %r{\A([\w+\-].?)+@[a-z\d\-]+(\.[a-z]+)*\.[a-z]+\z}
-    return (arguments[0] =~ valid_email_regex) == 0
+    return (arguments[0] =~ valid_email_regex) == 0 # rubocop:disable Style/NumericPredicate : Changing to '.zero?' breaks the code
   end
 end