Bring order to json

Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    dachsfisch (0.2.0)
+    dachsfisch (1.0.0)
       nokogiri (>= 1.14.1, < 2.0.0)
 
 GEM

README.md

@@ -22,6 +22,8 @@ The rules for converting XML documents to JSON using Badgerfish are:
 - CDATA sections become properties named `#1`, `#2`, etc.
 
 Please see our [examples](spec/support/examples.rb) for more details. Those rules are derived from [this list](http://dropbox.ashlock.us/open311/json-xml/).
+Own additions:
+- The order of nodes gets saved in `@@order` (JSON is unordered per definition)
 
 ## Installation
 
@@ -53,7 +55,7 @@ json = Dachsfisch::XML2JSONConverter.perform(xml: xml)
 ### JSON-to-XML
 
 ```ruby
-json = '{ "alice": { "$" : "bob" } }'
+json = '{ "alice": { "$1": "bob", "@@order": ["$1"] }, "@@order": ["alice"] }'
 xml = Dachsfisch::JSON2XMLConverter.perform(json: json)
 ```
 

lib/dachsfisch/json2_xml_converter.rb

@@ -23,8 +23,8 @@ def execute
     def add_element(xml, element)
       return unless element.is_a? Hash
 
-      element.each do |key, value|
-        add_node(xml, key, value) unless key.start_with?('@')
+      element['@@order']&.each do |key|
+        add_node(xml, key, element[key]) unless key.start_with?('@')
       end
     end
 
@@ -44,7 +44,7 @@ def add_node(xml, key, element)
     end
 
     def handle_attribute_and_namespaces(node, element)
-      element.keys.filter {|element_key| element_key.start_with?('@') }.each do |attribute_key|
+      element.keys.filter {|element_key| element_key.start_with?(/@[^@]/) }.each do |attribute_key|
         if attribute_key.start_with? '@xmlns'
           element[attribute_key].each do |namespace_key, namespace|
             # add namespace of current scope to node. The root-ns($) gets 'xmlns' as key, named namespaces 'xmlns:name' respectively.

lib/dachsfisch/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dachsfisch
-  VERSION = '0.2.0'
+  VERSION = '1.0.0'
 end

lib/dachsfisch/xml2_json_converter.rb

@@ -14,20 +14,27 @@ def execute
       @fragment.elements.deconstruct.each do |root|
         result[node_name(root)] = extract_node(root)
       end
+      add_order_to_hash result
       result.to_json
     end
 
     private
 
+    def add_order_to_hash(hash)
+      return if hash.keys.reject {|key| key.start_with?('@') }.empty?
+
+      hash['@@order'] = hash.keys.reject {|key| key.start_with?('@') }
+    end
+
     def extract_node(node)
       hash = {}
       active_namespaces = add_namespaces_to_active_namespaces(node)
       hash['@xmlns'] = active_namespaces unless active_namespaces.empty?
-
       handle_attributes(hash, node)
       node.children.each do |child|
         handle_content(hash, child)
       end
+      add_order_to_hash hash
       hash
     end