Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / regexpescape.rb
index 2cfa3bb..43b729e 100644 (file)
@@ -2,11 +2,14 @@
 #  regexpescape.rb
 #
 module Puppet::Parser::Functions
-  newfunction(:regexpescape, :type => :rvalue, :doc => <<-EOS
-    Regexp escape a string or array of strings.
-    Requires either a single string or an array as an input.
-    EOS
-  ) do |arguments| # rubocop:disable Style/ClosingParenthesisIndentation
+  newfunction(:regexpescape, :type => :rvalue, :doc => <<-DOC
+    @summary
+      Regexp escape a string or array of strings.
+      Requires either a single string or an array as an input.
+    @return [String]
+      A string of characters with metacharacters converted to their escaped form.
+    DOC
+  ) do |arguments| # rubocop:disable Layout/ClosingParenthesisIndentation
     raise(Puppet::ParseError, "regexpescape(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     value = arguments[0]
@@ -17,7 +20,7 @@ module Puppet::Parser::Functions
 
     result = if value.is_a?(Array)
                # Numbers in Puppet are often string-encoded which is troublesome ...
-               value.collect { |i| i.is_a?(String) ? Regexp.escape(i) : i }
+               value.map { |i| i.is_a?(String) ? Regexp.escape(i) : i }
              else
                Regexp.escape(value)
              end