Namespace function shell_escape()

Author: smortex

lib/puppet/functions/shell_escape.rb

@@ -1,25 +1,14 @@
 # frozen_string_literal: true
 
-# @summary
-#   Escapes a string so that it can be safely used in a Bourne shell command line.
-#
-# >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single
-# quotes.
-#
-# This function behaves the same as ruby's Shellwords.shellescape() function.
+# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims`
+
+# @summary DEPRECATED.  Use the namespaced function [`stdlib::shell_escape`](#stdlibshell_escape) instead.
 Puppet::Functions.create_function(:shell_escape) do
-  # @param string
-  #   The string to escape
-  #
-  # @return
-  #   An escaped string that can be safely used in a Bourne shell command line.
-  dispatch :shell_escape do
-    param 'Any', :string
+  dispatch :deprecation_gen do
+    repeated_param 'Any', :args
   end
-
-  def shell_escape(string)
-    require 'shellwords'
-
-    Shellwords.shellescape(string.to_s)
+  def deprecation_gen(*args)
+    call_function('deprecation', 'shell_escape', 'This function is deprecated, please use stdlib::shell_escape instead.')
+    call_function('stdlib::shell_escape', *args)
   end
 end

lib/puppet/functions/stdlib/shell_escape.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# @summary
+#   Escapes a string so that it can be safely used in a Bourne shell command line.
+#
+# >* Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single
+# quotes.
+#
+# This function behaves the same as ruby's Shellwords.shellescape() function.
+Puppet::Functions.create_function(:'stdlib::shell_escape') do
+  # @param string
+  #   The string to escape
+  #
+  # @return
+  #   An escaped string that can be safely used in a Bourne shell command line.
+  dispatch :shell_escape do
+    param 'Any', :string
+  end
+
+  def shell_escape(string)
+    require 'shellwords'
+
+    Shellwords.shellescape(string.to_s)
+  end
+end

spec/functions/shell_escape_spec.rb

@@ -2,12 +2,12 @@
 
 require 'spec_helper'
 
-describe 'shell_escape' do
+describe 'stdlib::shell_escape' do
   it { is_expected.not_to be_nil }
 
   describe 'signature validation' do
-    it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'shell_escape' expects 1 argument, got none}) }
-    it { is_expected.to run.with_params('foo', 'bar').and_raise_error(ArgumentError, %r{'shell_escape' expects 1 argument, got 2}) }
+    it { is_expected.to run.with_params.and_raise_error(ArgumentError, %r{'stdlib::shell_escape' expects 1 argument, got none}) }
+    it { is_expected.to run.with_params('foo', 'bar').and_raise_error(ArgumentError, %r{'stdlib::shell_escape' expects 1 argument, got 2}) }
   end
 
   describe 'stringification' do