Update stdlib and concat to 6.1.0 both
[mirror/dsa-puppet.git] / 3rdparty / modules / stdlib / lib / puppet / parser / functions / swapcase.rb
index eb7fe13..dd17330 100644 (file)
@@ -1,35 +1,36 @@
 #
 #  swapcase.rb
+#  Please note: This function is an implementation of a Ruby class and as such may not be entirely UTF8 compatible. To ensure compatibility please use this function with Ruby 2.4.0 or greater - https://bugs.ruby-lang.org/issues/10085.
 #
-
 module Puppet::Parser::Functions
-  newfunction(:swapcase, :type => :rvalue, :doc => <<-EOS
-This function will swap the existing case of a string.
+  newfunction(:swapcase, :type => :rvalue, :doc => <<-DOC
+    @summary
+      This function will swap the existing case of a string.
 
-*Examples:*
+    @return
+      string with uppercase alphabetic characters converted to lowercase and lowercase characters converted to uppercase
 
-    swapcase("aBcD")
+    @example **Usage**
 
-Would result in: "AbCd"
-    EOS
-  ) do |arguments|
+      swapcase("aBcD")
+      Would result in: "AbCd"
+    DOC
+             ) do |arguments|
 
-    raise(Puppet::ParseError, "swapcase(): Wrong number of arguments " +
-      "given (#{arguments.size} for 1)") if arguments.size < 1
+    raise(Puppet::ParseError, "swapcase(): Wrong number of arguments given (#{arguments.size} for 1)") if arguments.empty?
 
     value = arguments[0]
 
     unless value.is_a?(Array) || value.is_a?(String)
-      raise(Puppet::ParseError, 'swapcase(): Requires either ' +
-        'array or string to work with')
+      raise(Puppet::ParseError, 'swapcase(): Requires either array or string to work with')
     end
 
-    if value.is_a?(Array)
-      # Numbers in Puppet are often string-encoded which is troublesome ...
-      result = value.collect { |i| i.is_a?(String) ? i.swapcase : i }
-    else
-      result = value.swapcase
-    end
+    result = if value.is_a?(Array)
+               # Numbers in Puppet are often string-encoded which is troublesome ...
+               value.map { |i| i.is_a?(String) ? i.swapcase : i }
+             else
+               value.swapcase
+             end
 
     return result
   end