From 0fc53f13dd92f21048dd48de54b5bb50cce6e963 Mon Sep 17 00:00:00 2001
From: Ben Ford <ben.ford@puppetlabs.com>
Date: Sat, 4 Jan 2020 00:28:13 -0800
Subject: [PATCH] Porting functions to the modern Puppet 4.x API

---
 lib/puppet/functions/sorted_json.rb | 68 +++++++++++++++++++++++++++++
 spec/functions/_sorted_json_spec.rb | 41 +++++++++++++++++
 2 files changed, 109 insertions(+)
 create mode 100644 lib/puppet/functions/sorted_json.rb
 create mode 100644 spec/functions/_sorted_json_spec.rb

diff --git a/lib/puppet/functions/sorted_json.rb b/lib/puppet/functions/sorted_json.rb
new file mode 100644
index 0000000..730fa1d
--- /dev/null
+++ b/lib/puppet/functions/sorted_json.rb
@@ -0,0 +1,68 @@
+# This is an autogenerated function, ported from the original legacy version.
+# It /should work/ as is, but will not have all the benefits of the modern
+# function API. You should see the function docs to learn how to add function
+# signatures for type safety and to document this function using puppet-strings.
+#
+# https://puppet.com/docs/puppet/latest/custom_functions_ruby.html
+#
+# ---- original file header ----
+require 'json'
+
+def sorted_json(obj)
+  case obj
+    when String, Fixnum, Float, TrueClass, FalseClass, NilClass
+      return obj.to_json
+    when Array
+      arrayRet = []
+      obj.each do |a|
+        arrayRet.push(sorted_json(a))
+      end
+      return "[" << arrayRet.join(',') << "]";
+    when Hash
+      ret = []
+      obj.keys.sort.each do |k|
+        ret.push(k.to_json << ":" << sorted_json(obj[k]))
+      end
+      return "{" << ret.join(",") << "}";
+    else
+      raise Exception("Unable to handle object of type <%s>" % obj.class.to_s)
+  end
+end
+
+# ---- original file header ----
+#
+# @summary
+#   This function takes data, outputs making sure the hash keys are sorted
+#
+#*Examples:*
+#
+#    sorted_json({'key'=>'value'})
+#
+#Would return: {'key':'value'}
+#
+#
+Puppet::Functions.create_function(:'sorted_json') do
+  # @param arguments
+  #   The original array of arguments. Port this to individually managed params
+  #   to get the full benefit of the modern function API.
+  #
+  # @return [Data type]
+  #   Describe what the function returns here
+  #
+  dispatch :default_impl do
+    # Call the method named 'default_impl' when this is matched
+    # Port this to match individual params for better type safety
+    repeated_param 'Any', :arguments
+  end
+
+
+  def default_impl(*arguments)
+    
+    raise(Puppet::ParseError, "sorted_json(): Wrong number of arguments " +
+      "given (#{arguments.size} for 1)") if arguments.size != 1
+
+    json = arguments[0]
+    return sorted_json(json)
+  
+  end
+end
diff --git a/spec/functions/_sorted_json_spec.rb b/spec/functions/_sorted_json_spec.rb
new file mode 100644
index 0000000..704beec
--- /dev/null
+++ b/spec/functions/_sorted_json_spec.rb
@@ -0,0 +1,41 @@
+require 'spec_helper'
+
+describe 'sorted_json' do
+  # without knowing details about the implementation, this is the only test
+  # case that we can autogenerate. You should add more examples below!
+  it { is_expected.not_to eq(nil) }
+
+#################################
+# Below are some example test cases. You may uncomment and modify them to match
+# your needs. Notice that they all expect the base error class of `StandardError`.
+# This is because the autogenerated function uses an untyped array for parameters
+# and relies on your implementation to do the validation. As you convert your
+# function to proper dispatches and typed signatures, you should change the
+# expected error of the argument validation examples to `ArgumentError`.
+#
+# Other error types you might encounter include
+#
+# * StandardError
+# * ArgumentError
+# * Puppet::ParseError
+#
+# Read more about writing function unit tests at https://rspec-puppet.com/documentation/functions/
+#
+#   it 'raises an error if called with no argument' do
+#     is_expected.to run.with_params.and_raise_error(StandardError)
+#   end
+#
+#   it 'raises an error if there is more than 1 arguments' do
+#     is_expected.to run.with_params({ 'foo' => 1 }, 'bar' => 2).and_raise_error(StandardError)
+#   end
+#
+#   it 'raises an error if argument is not the proper type' do
+#     is_expected.to run.with_params('foo').and_raise_error(StandardError)
+#   end
+#
+#   it 'returns the proper output' do
+#     is_expected.to run.with_params(123).and_return('the expected output')
+#   end
+#################################
+
+end