Namespace function fqdn_rand_string()

Author: smortex

lib/puppet/functions/fqdn_rand_string.rb

@@ -1,37 +1,14 @@
 # frozen_string_literal: true
 
-# @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).
+# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims`
+
+# @summary DEPRECATED.  Use the namespaced function [`stdlib::fqdn_rand_string`](#stdlibfqdn_rand_string) instead.
 Puppet::Functions.create_function(:fqdn_rand_string) do
-  # @param length The length of the resulting string.
-  # @param charset The character set to use.
-  # @param 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')
-  dispatch :fqdn_rand_string do
-    param 'Integer[1]', :length
-    optional_param 'String', :charset
-    optional_repeated_param 'Any', :seed
+  dispatch :deprecation_gen do
+    repeated_param 'Any', :args
   end
-
-  def fqdn_rand_string(length, charset = '', *seed)
-    charset = charset.chars.to_a
-
-    charset = (0..9).map(&:to_s) + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty?
-
-    rand_string = ''
-    length.times do |current|
-      rand_string += charset[call_function('fqdn_rand', charset.size, (seed + [current + 1]).join(':'))]
-    end
-
-    rand_string
+  def deprecation_gen(*args)
+    call_function('deprecation', 'fqdn_rand_string', 'This function is deprecated, please use stdlib::fqdn_rand_string instead.')
+    call_function('stdlib::fqdn_rand_string', *args)
   end
 end

lib/puppet/functions/stdlib/fqdn_rand_string.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+# @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).
+Puppet::Functions.create_function(:'stdlib::fqdn_rand_string') do
+  # @param length The length of the resulting string.
+  # @param charset The character set to use.
+  # @param The seed for repeatable randomness.
+  #
+  # @return [String]
+  #
+  # @example Example Usage:
+  #   stdlib::fqdn_rand_string(10)
+  #   stdlib::fqdn_rand_string(10, 'ABCDEF!@$%^')
+  #   stdlib::fqdn_rand_string(10, '', 'custom seed')
+  dispatch :fqdn_rand_string do
+    param 'Integer[1]', :length
+    optional_param 'String', :charset
+    optional_repeated_param 'Any', :seed
+  end
+
+  def fqdn_rand_string(length, charset = '', *seed)
+    charset = charset.chars.to_a
+
+    charset = (0..9).map(&:to_s) + ('A'..'Z').to_a + ('a'..'z').to_a if charset.empty?
+
+    rand_string = ''
+    length.times do |current|
+      rand_string += charset[call_function('fqdn_rand', charset.size, (seed + [current + 1]).join(':'))]
+    end
+
+    rand_string
+  end
+end

spec/functions/fqdn_rand_string_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe 'fqdn_rand_string' do
+describe 'stdlib::fqdn_rand_string' do
   let(:default_charset) { %r{\A[a-zA-Z0-9]{100}\z} }
 
   it { is_expected.not_to be_nil }