Namespace function seeded_rand_string()

Author: smortex

lib/puppet/functions/seeded_rand_string.rb

@@ -1,32 +1,14 @@
 # frozen_string_literal: true
 
-# @summary
-#   Generates a consistent random string of specific length based on provided seed.
-#
-# @example Generate a consistently random string of length 8 with a seed:
-#   seeded_rand_string(8, "${module_name}::redis_password")
-#
-# @example Generate a random string from a specific set of characters:
-#   seeded_rand_string(5, '', 'abcdef')
+# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims`
+
+# @summary DEPRECATED.  Use the namespaced function [`stdlib::seeded_rand_string`](#stdlibseeded_rand_string) instead.
 Puppet::Functions.create_function(:seeded_rand_string) do
-  # @param length Length of string to be generated.
-  # @param seed Seed string.
-  # @param charset String that contains characters to use for the random string.
-  #
-  # @return [String] Random string.
-  dispatch :rand_string do
-    param 'Integer[1]', :length
-    param 'String', :seed
-    optional_param 'String[2]', :charset
+  dispatch :deprecation_gen do
+    repeated_param 'Any', :args
   end
-
-  def rand_string(length, seed, charset = nil)
-    require 'digest/sha2'
-
-    charset ||= '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
-
-    random_generator = Random.new(Digest::SHA256.hexdigest(seed).to_i(16))
-
-    Array.new(length) { charset[random_generator.rand(charset.size)] }.join
+  def deprecation_gen(*args)
+    call_function('deprecation', 'seeded_rand_string', 'This function is deprecated, please use stdlib::seeded_rand_string instead.')
+    call_function('stdlib::seeded_rand_string', *args)
   end
 end

lib/puppet/functions/stdlib/seeded_rand_string.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+# @summary
+#   Generates a consistent random string of specific length based on provided seed.
+#
+# @example Generate a consistently random string of length 8 with a seed:
+#   stdlib::seeded_rand_string(8, "${module_name}::redis_password")
+#
+# @example Generate a random string from a specific set of characters:
+#   stdlib::seeded_rand_string(5, '', 'abcdef')
+Puppet::Functions.create_function(:'stdlib::seeded_rand_string') do
+  # @param length Length of string to be generated.
+  # @param seed Seed string.
+  # @param charset String that contains characters to use for the random string.
+  #
+  # @return [String] Random string.
+  dispatch :rand_string do
+    param 'Integer[1]', :length
+    param 'String', :seed
+    optional_param 'String[2]', :charset
+  end
+
+  def rand_string(length, seed, charset = nil)
+    require 'digest/sha2'
+
+    charset ||= '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+
+    random_generator = Random.new(Digest::SHA256.hexdigest(seed).to_i(16))
+
+    Array.new(length) { charset[random_generator.rand(charset.size)] }.join
+  end
+end

spec/functions/seeded_rand_string_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe 'seeded_rand_string' do
+describe 'stdlib::seeded_rand_string' do
   it { is_expected.not_to be(nil) }
 
   # Test for erroneous params
@@ -22,14 +22,14 @@
 
   # Test behavior
   it 'generates the same string with the same seed' do
-    rand_str_one = call_function(:seeded_rand_string, 300, 'my_seed')
-    rand_str_two = call_function(:seeded_rand_string, 300, 'my_seed')
+    rand_str_one = call_function(:'stdlib::seeded_rand_string', 300, 'my_seed')
+    rand_str_two = call_function(:'stdlib::seeded_rand_string', 300, 'my_seed')
 
     expect(rand_str_one).to eq(rand_str_two)
   end
   it 'generates different strings if seeded differently' do
-    rand_str_one = call_function(:seeded_rand_string, 300, 'my_seed_one')
-    rand_str_two = call_function(:seeded_rand_string, 300, 'my_seed_two')
+    rand_str_one = call_function(:'stdlib::seeded_rand_string', 300, 'my_seed_one')
+    rand_str_two = call_function(:'stdlib::seeded_rand_string', 300, 'my_seed_two')
 
     expect(rand_str_one).not_to eq(rand_str_two)
   end