Skip to content

Instantly share code, notes, and snippets.

Created April 2, 2012 23:13
  • Star 20 You must be signed in to star a gist
  • Fork 3 You must be signed in to fork a gist
Star You must be signed in to star a gist
Save halkeye/2287885 to your computer and use it in GitHub Desktop.
Puppet module for outputting json in a sorted consistent way
# sorted_json.rb
# Puppet module for outputting json in a sorted consistent way. I use it for creating config files with puppet
require 'json'
def sorted_json(json)
if (json.kind_of? String)
return json.to_json
elsif (json.kind_of? Array)
arrayRet = []
json.each do |a|
return "[" << arrayRet.join(',') << "]";
elsif (json.kind_of? Hash)
ret = []
json.keys.sort.each do |k|
ret.push(k.to_json << ":" << sorted_json(json[k]))
return "{" << ret.join(",") << "}";
raise Exception("Unable to handle object of type " + json.class)
module Puppet::Parser::Functions
newfunction(:sorted_json, :type => :rvalue, :doc => <<-EOS
This function takes data, outputs making sure the hash keys are sorted
Would return: {'key':'value'}
) do |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)
# vim: set ts=2 sw=2 et :
Copy link

I updated this puppet function to properly cast quoted numbers to integers because some services expect their port numbers to be unquoted: { "port": "80" } vs { "port": 80 }.

I also added support to generate pretty config with toggle-able indentation.

Copy link

I needed same thing for yaml, so I modified one of the above scripts for yaml syntax. No complex structures though, just enough to get me going.

Copy link

+1 on a function like this being a part of stdlib. I see it duplicated across a bunch of modules. Also, It would be great if we could get an official version on this somewhere with a license file. I hate it when I get blocked by policy when I can't bring code in without a release version (Our policies won't allow for a commit sha as a version :/ )

Copy link

jcrsilva commented Feb 23, 2017

+2 on stdlib

edit: and this is 4 years old, it'd be about time

Copy link

KlavsKlavsen commented Jun 28, 2017

Simple puppet 4 edition

require 'json'

Puppet::Functions.create_function(:sorted_json) do
  dispatch :sorted_json do
    param 'Hash', :arg

  def sorted_generate(obj)
    case obj
      when Fixnum, Float, TrueClass, FalseClass, NilClass
        return obj.to_json
      when String
        # Convert quoted integers (string) to int
        return (obj.match(/\A[-]?[0-9]+\z/) ? obj.to_i : obj).to_json
      when Array
        arrayRet = []
        obj.each do |a|
        return "[" << arrayRet.join(',') << "]";
      when Hash
        ret = []
        obj.keys.sort.each do |k|
          ret.push(k.to_json << ":" << sorted_generate(obj[k]))
        return "{" << ret.join(",") << "}";
        raise Exception("Unable to handle object of type <%s>" % obj.class.to_s)
  end # end def

  def sorted_json(h)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment