Namespace function to_ruby()

Author: smortex

lib/puppet/functions/stdlib/to_ruby.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+# @summary
+#   Convert an object into a String containing its Ruby representation
+#
+# @example how to output Ruby
+#   # output Ruby to a file
+#   $listen = '0.0.0.0'
+#   $port = 8000
+#   file { '/opt/acme/etc/settings.rb':
+#     content => inline_epp(@("SETTINGS")),
+#       LISTEN = <%= stdlib::to_ruby($listen) %>
+#       PORT = <%= stdlib::to_ruby($mailserver) %>
+#       | SETTINGS
+#   }
+
+Puppet::Functions.create_function(:'stdlib::to_ruby') do
+  # @param object
+  #   The object to be converted
+  #
+  # @return [String]
+  #   The String representation of the object
+  dispatch :to_ruby do
+    param 'Any', :object
+  end
+
+  def to_ruby(object)
+    serialized = Puppet::Pops::Serialization::ToDataConverter.convert(object, rich_data: true)
+    serialized_to_ruby(serialized)
+  end
+
+  def serialized_to_ruby(serialized)
+    case serialized
+    when Array then "[#{serialized.map { |x| serialized_to_ruby(x) }.join(', ')}]"
+    when Hash then "{#{serialized.map { |k, v| "#{serialized_to_ruby(k)} => #{serialized_to_ruby(v)}" }.join(', ')}}"
+    else serialized.inspect
+    end
+  end
+end

lib/puppet/functions/to_ruby.rb

@@ -1,39 +1,14 @@
 # frozen_string_literal: true
 
-# @summary
-#   Convert an object into a String containing its Ruby representation
-#
-# @example how to output Ruby
-#   # output Ruby to a file
-#   $listen = '0.0.0.0'
-#   $port = 8000
-#   file { '/opt/acme/etc/settings.rb':
-#     content => inline_epp(@("SETTINGS")),
-#       LISTEN = <%= $listen.to_ruby %>
-#       PORT = <%= $mailserver.to_ruby %>
-#       | SETTINGS
-#   }
+# THIS FILE WAS GENERATED BY `rake regenerate_unamespaced_shims`
 
+# @summary DEPRECATED.  Use the namespaced function [`stdlib::to_ruby`](#stdlibto_ruby) instead.
 Puppet::Functions.create_function(:to_ruby) do
-  # @param object
-  #   The object to be converted
-  #
-  # @return [String]
-  #   The String representation of the object
-  dispatch :to_ruby do
-    param 'Any', :object
+  dispatch :deprecation_gen do
+    repeated_param 'Any', :args
   end
-
-  def to_ruby(object)
-    serialized = Puppet::Pops::Serialization::ToDataConverter.convert(object, rich_data: true)
-    serialized_to_ruby(serialized)
-  end
-
-  def serialized_to_ruby(serialized)
-    case serialized
-    when Array then "[#{serialized.map { |x| serialized_to_ruby(x) }.join(', ')}]"
-    when Hash then "{#{serialized.map { |k, v| "#{serialized_to_ruby(k)} => #{serialized_to_ruby(v)}" }.join(', ')}}"
-    else serialized.inspect
-    end
+  def deprecation_gen(*args)
+    call_function('deprecation', 'to_ruby', 'This function is deprecated, please use stdlib::to_ruby instead.')
+    call_function('stdlib::to_ruby', *args)
   end
 end

spec/functions/to_ruby_spec.rb

@@ -2,7 +2,7 @@
 
 require 'spec_helper'
 
-describe 'to_ruby' do
+describe 'stdlib::to_ruby' do
   it { is_expected.not_to be_nil }
   it { is_expected.to run.with_params('').and_return('""') }
   it { is_expected.to run.with_params(nil).and_return('nil') }