Namespace function batch_escape()

Author: smortex

lib/puppet/functions/batch_escape.rb

@@ -1,31 +1,14 @@
 # frozen_string_literal: true
 
-# @summary
-#   Escapes a string so that it can be safely used in a batch 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 FILE WAS GENERATED BY `rake regenerate_unamespaced_shims`
+
+# @summary DEPRECATED.  Use the namespaced function [`stdlib::batch_escape`](#stdlibbatch_escape) instead.
 Puppet::Functions.create_function(:batch_escape) do
-  # @param string
-  #   The string to escape
-  #
-  # @return
-  #   An escaped string that can be safely used in a batch command line.
-  dispatch :batch_escape do
-    param 'Any', :string
+  dispatch :deprecation_gen do
+    repeated_param 'Any', :args
   end
-
-  def batch_escape(string)
-    result = ''
-
-    string.to_s.chars.each do |char|
-      result += case char
-                when '"' then '""'
-                when '$', '\\' then "\\#{char}"
-                else char
-                end
-    end
-
-    %("#{result}")
+  def deprecation_gen(*args)
+    call_function('deprecation', 'batch_escape', 'This function is deprecated, please use stdlib::batch_escape instead.')
+    call_function('stdlib::batch_escape', *args)
   end
 end

lib/puppet/functions/stdlib/batch_escape.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+# @summary
+#   Escapes a string so that it can be safely used in a batch 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.
+Puppet::Functions.create_function(:'stdlib::batch_escape') do
+  # @param string
+  #   The string to escape
+  #
+  # @return
+  #   An escaped string that can be safely used in a batch command line.
+  dispatch :batch_escape do
+    param 'Any', :string
+  end
+
+  def batch_escape(string)
+    result = ''
+
+    string.to_s.chars.each do |char|
+      result += case char
+                when '"' then '""'
+                when '$', '\\' then "\\#{char}"
+                else char
+                end
+    end
+
+    %("#{result}")
+  end
+end

spec/functions/batch_escape_spec.rb

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