Namespace function validate_email_address()

Author: smortex

lib/puppet/functions/stdlib/validate_email_address.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# @summary
+#   Validate that all values passed are valid email addresses.
+#   Fail compilation if any value fails this check.
+Puppet::Functions.create_function(:'stdlib::validate_email_address') do
+  # @param values An e-mail address or an array of e-mail addresses to check
+  #
+  # @return [Undef]
+  #   Fail compilation if any value fails this check.
+  #
+  # @example Passing examples
+  #   $my_email = "waldo@gmail.com"
+  #   stdlib::validate_email_address($my_email)
+  #   stdlib::validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email)
+  #
+  # @example Failing examples (causing compilation to abort)
+  #   $some_array = [ 'bad_email@/d/efdf.com' ]
+  #   stdlib::validate_email_address($some_array)
+  dispatch :validate_email_address do
+    repeated_param 'Stdlib::Email', :values
+  end
+
+  def validate_email_address(*args)
+    assert_arg_count(args)
+  end
+
+  def assert_arg_count(args)
+    raise(ArgumentError, 'stdlib::validate_email_address(): Wrong number of arguments need at least one') if args.empty?
+  end
+end

lib/puppet/functions/validate_email_address.rb

@@ -1,31 +1,14 @@
 # frozen_string_literal: true
 
-# @summary
-#   Validate that all values passed are valid email addresses.
-#   Fail compilation if any value fails this check.
-Puppet::Functions.create_function(:validate_email_address) do
-  # @param values An e-mail address or an array of e-mail addresses to check
-  #
-  # @return [Undef]
-  #   Fail compilation if any value fails this check.
-  #
-  # @example Passing examples
-  #   $my_email = "waldo@gmail.com"
-  #   validate_email_address($my_email)
-  #   validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email)
-  #
-  # @example Failing examples (causing compilation to abort)
-  #   $some_array = [ 'bad_email@/d/efdf.com' ]
-  #   validate_email_address($some_array)
-  dispatch :validate_email_address do
-    repeated_param 'Stdlib::Email', :values
-  end
+# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims`
 
-  def validate_email_address(*args)
-    assert_arg_count(args)
+# @summary DEPRECATED.  Use the namespaced function [`stdlib::validate_email_address`](#stdlibvalidate_email_address) instead.
+Puppet::Functions.create_function(:validate_email_address) do
+  dispatch :deprecation_gen do
+    repeated_param 'Any', :args
   end
-
-  def assert_arg_count(args)
-    raise(ArgumentError, 'validate_email_address(): Wrong number of arguments need at least one') if args.empty?
+  def deprecation_gen(*args)
+    call_function('deprecation', 'validate_email_address', 'This function is deprecated, please use stdlib::validate_email_address instead.')
+    call_function('stdlib::validate_email_address', *args)
   end
 end

spec/functions/validate_email_address_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe 'validate_email_address' do
+describe 'stdlib::validate_email_address' do
   describe 'signature validation' do
     it { is_expected.not_to eq(nil) }
     it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{wrong number of arguments}i) }