X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Fbase64.rb;h=d77db8bbfbabfd85abd20c2bd84a97c5262e112a;hb=131e09855e065be940e104d9ab0f18940cc76257;hp=d61014607f176ed3fdc6c83d42c62801df2ccd28;hpb=407d322498f4fde815abf381007fbecfe5c10b2b;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/base64.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/base64.rb
index d61014607..d77db8bbf 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/base64.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/base64.rb
@@ -1,10 +1,6 @@
-
 #  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(:base64, :type => :rvalue, :doc => <<-'ENDHEREDOC') do |args|
-
+  newfunction(:base64, :type => :rvalue, :doc => <<-'DOC') do |args|
     Base64 encode or decode a string based on the command and the string submitted
 
     Usage:
@@ -17,53 +13,62 @@ module Puppet::Parser::Functions
       $encodestring = base64('encode', 'thestring', $method)
       $decodestring = base64('decode', 'dGhlc3RyaW5n', $method)
 
-    ENDHEREDOC
+    Note: Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings.
+    See the `new()` function for the Binary and String types for documentation. Also see `binary_file()`
+    function for reading a file with binary (non UTF-8) content.
+
+       # encode a string as if it was binary
+       $encodestring = String(Binary('thestring', '%s'))
+       # decode a Binary assuming it is an UTF-8 String
+       $decodestring = String(Binary("dGhlc3RyaW5n"), "%s")
+
+    DOC
 
     require 'base64'
 
-    raise Puppet::ParseError, ("base64(): Wrong number of arguments (#{args.length}; must be >= 2)") unless args.length >= 2
+    raise Puppet::ParseError, "base64(): Wrong number of arguments (#{args.length}; must be >= 2)" unless args.length >= 2
 
-    actions = ['encode','decode']
+    actions = ['encode', 'decode']
 
     unless actions.include?(args[0])
-      raise Puppet::ParseError, ("base64(): the first argument must be one of 'encode' or 'decode'")
+      raise Puppet::ParseError, "base64(): the first argument must be one of 'encode' or 'decode'"
     end
 
     unless args[1].is_a?(String)
-      raise Puppet::ParseError, ("base64(): the second argument must be a string to base64")
+      raise Puppet::ParseError, 'base64(): the second argument must be a string to base64'
     end
 
-    method = ['default','strict','urlsafe']
+    method = ['default', 'strict', 'urlsafe']
 
-    if args.length <= 2
-      chosenMethod = 'default'
-    else
-      chosenMethod = args[2]
-    end
+    chosen_method = if args.length <= 2
+                      'default'
+                    else
+                      args[2]
+                    end
 
-    unless method.include?(chosenMethod)
-      raise Puppet::ParseError, ("base64(): the third argument must be one of 'default', 'strict', or 'urlsafe'")
+    unless method.include?(chosen_method)
+      raise Puppet::ParseError, "base64(): the third argument must be one of 'default', 'strict', or 'urlsafe'"
     end
 
     case args[0]
-      when 'encode'
-        case chosenMethod
-          when 'default'
-            result = Base64.encode64(args[1])
-          when 'strict'
-            result = Base64.strict_encode64(args[1])
-          when 'urlsafe'
-            result = Base64.urlsafe_encode64(args[1])
-        end
-      when 'decode'
-        case chosenMethod
-          when 'default'
-            result = Base64.decode64(args[1])
-          when 'strict'
-            result = Base64.strict_decode64(args[1])
-          when 'urlsafe'
-            result = Base64.urlsafe_decode64(args[1])
-        end
+    when 'encode'
+      case chosen_method
+      when 'default'
+        result = Base64.encode64(args[1])
+      when 'strict'
+        result = Base64.strict_encode64(args[1])
+      when 'urlsafe'
+        result = Base64.urlsafe_encode64(args[1])
+      end
+    when 'decode'
+      case chosen_method
+      when 'default'
+        result = Base64.decode64(args[1])
+      when 'strict'
+        result = Base64.strict_decode64(args[1])
+      when 'urlsafe'
+        result = Base64.urlsafe_decode64(args[1])
+      end
     end
 
     return result