X-Git-Url: https://git.adam-barratt.org.uk/?a=blobdiff_plain;f=3rdparty%2Fmodules%2Fstdlib%2Flib%2Fpuppet%2Fparser%2Ffunctions%2Ffqdn_rand_string.rb;h=9bfba73d65d87ac59b1c5a3d243c65b03744123d;hb=30caaa85aed7015ca0d77216bff175eebd917eb7;hp=2bb1287e06be42f612cdd4805bc98282804e68c3;hpb=6963202b4b62c2816655ac9532521b018fdf83bd;p=mirror%2Fdsa-puppet.git

diff --git a/3rdparty/modules/stdlib/lib/puppet/parser/functions/fqdn_rand_string.rb b/3rdparty/modules/stdlib/lib/puppet/parser/functions/fqdn_rand_string.rb
index 2bb1287e0..9bfba73d6 100644
--- a/3rdparty/modules/stdlib/lib/puppet/parser/functions/fqdn_rand_string.rb
+++ b/3rdparty/modules/stdlib/lib/puppet/parser/functions/fqdn_rand_string.rb
@@ -1,34 +1,43 @@
-Puppet::Parser::Functions::newfunction(
+Puppet::Parser::Functions.newfunction(
   :fqdn_rand_string,
   :arity => -2,
   :type => :rvalue,
-  :doc => "Usage: `fqdn_rand_string(LENGTH, [CHARSET], [SEED])`. LENGTH is
-  required and must be a positive integer. CHARSET is optional and may be
-  `undef` or a string. SEED is optional and may be any number or string.
-
-  Generates a random string LENGTH characters long using the character set
-  provided by CHARSET, combining the `$fqdn` fact and the value of SEED for
-  repeatable randomness. (That is, each node will get a different random
-  string from this function, but a given node's result will be the same every
-  time unless its hostname changes.) Adding a SEED can be useful if you need
-  more than one unrelated string. CHARSET will default to alphanumeric if
-  `undef` or an empty string.") do |args|
-    raise(ArgumentError, "fqdn_rand_string(): wrong number of arguments (0 for 1)") if args.size == 0
-    Puppet::Parser::Functions.function('is_integer')
-    raise(ArgumentError, "fqdn_rand_string(): first argument must be a positive integer") unless function_is_integer([args[0]]) and args[0].to_i > 0
-    raise(ArgumentError, "fqdn_rand_string(): second argument must be undef or a string") unless args[1].nil? or args[1].is_a? String
-
-    Puppet::Parser::Functions.function('fqdn_rand')
-
-    length = args.shift.to_i
-    charset = args.shift.to_s.chars.to_a
-
-    charset = (0..9).map { |i| i.to_s } + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty?
-
-    rand_string = ''
-    for current in 1..length
-      rand_string << charset[function_fqdn_rand([charset.size, (args + [current.to_s]).join(':')]).to_i]
-    end
-
-    rand_string
+  :doc => <<-DOC
+  @summary
+    Generates a random alphanumeric string. Combining the `$fqdn` fact and an
+    optional seed for repeatable randomness.
+
+  Optionally, you can specify a character set for the function (defaults to alphanumeric).
+
+  Arguments
+  * An integer, specifying the length of the resulting string.
+  * Optionally, a string specifying the character set.
+  * Optionally, a string specifying the seed for repeatable randomness.
+
+  @return [String]
+
+  @example Example Usage:
+    fqdn_rand_string(10)
+    fqdn_rand_string(10, 'ABCDEF!@$%^')
+    fqdn_rand_string(10, '', 'custom seed')
+  DOC
+) do |args|
+  raise(ArgumentError, 'fqdn_rand_string(): wrong number of arguments (0 for 1)') if args.empty?
+  Puppet::Parser::Functions.function('is_integer')
+  raise(ArgumentError, 'fqdn_rand_string(): first argument must be a positive integer') unless function_is_integer([args[0]]) && args[0].to_i > 0
+  raise(ArgumentError, 'fqdn_rand_string(): second argument must be undef or a string') unless args[1].nil? || args[1].is_a?(String)
+
+  Puppet::Parser::Functions.function('fqdn_rand')
+
+  length = args.shift.to_i
+  charset = args.shift.to_s.chars.to_a
+
+  charset = (0..9).map { |i| i.to_s } + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty?
+
+  rand_string = ''
+  for current in 1..length # rubocop:disable Style/For : An each loop would not work correctly in this circumstance
+    rand_string << charset[function_fqdn_rand([charset.size, (args + [current.to_s]).join(':')]).to_i]
+  end
+
+  rand_string
 end