Makes lexicographical sorting optional, preserving original object order instead

Author: dnllowe

src/json-ld.net/Core/JsonLdApi.cs

@@ -122,7 +122,12 @@ public virtual JToken Compact(Context activeCtx, string activeProperty, JToken e
                 JObject result = new JObject();
                 // 7)
                 JArray keys = new JArray(element.GetKeys());
-                keys.SortInPlace();
+
+                if (!opts.GetPreserveOrder())
+                {
+                    keys.SortInPlace();
+                }
+
                 foreach (string expandedProperty in keys)
                 {
                     JToken expandedValue = elem[expandedProperty];
@@ -491,7 +496,12 @@ public virtual JToken Expand(Context activeCtx, string activeProperty, JToken el
                     JObject result = new JObject();
                     // 7)
                     JArray keys = new JArray(element.GetKeys());
-                    keys.SortInPlace();
+
+                    if (!opts.GetPreserveOrder())
+                    {
+                        keys.SortInPlace();
+                    }
+
                     foreach (string key in keys)
                     {
                         JToken value = elem[key];
@@ -808,7 +818,12 @@ public virtual JToken Expand(Context activeCtx, string activeProperty, JToken el
                                     expandedValue = new JArray();
                                     // 7.6.2)
                                     JArray indexKeys = new JArray(value.GetKeys());
-                                    indexKeys.SortInPlace();
+
+                                    if (!opts.GetPreserveOrder())
+                                    {
+                                        indexKeys.SortInPlace();
+                                    }
+
                                     foreach (string index in indexKeys)
                                     {
                                         JToken indexValue = ((JObject)value)[index];
@@ -1290,7 +1305,12 @@ private void GenerateNodeMap(JToken element, JObject nodeMap,
                     }
                     // 6.11)
                     JArray keys = new JArray(element.GetKeys());
-                    keys.SortInPlace();
+
+                    if (!opts.GetPreserveOrder())
+                    {
+                        keys.SortInPlace();
+                    }
+
                     foreach (string property_1 in keys)
                     {
                         var eachProperty_1 = property_1;
@@ -1405,7 +1425,7 @@ public virtual JArray Frame(JToken input, JArray frame)
             {
                 state.omitDefault = this.opts.GetOmitDefault().Value;
             }
-            // use tree map so keys are sotred by default
+            // use tree map so keys are sorted by default
             // XXX BUG BUG BUG XXX (sblom) Figure out where this needs to be sorted and use extension methods to return sorted enumerators or something!
             JObject nodes = new JObject();
             GenerateNodeMap(input, nodes);
@@ -1436,7 +1456,12 @@ private void Frame(JsonLdApi.FramingContext state, JObject nodes
             bool explicitOn = GetFrameFlag(frame, "@explicit", state.@explicit);
             // add matches to output
             JArray ids = new JArray(matches.GetKeys());
-            ids.SortInPlace();
+
+            if (!opts.GetPreserveOrder())
+            {
+                ids.SortInPlace();
+            }
+
             foreach (string id in ids)
             {
                 if (property == null)
@@ -1499,7 +1524,12 @@ private void Frame(JsonLdApi.FramingContext state, JObject nodes
                     // iterate over subject properties
                     JObject element = (JObject)matches[id];
                     JArray props = new JArray(element.GetKeys());
-                    props.SortInPlace();
+
+                    if (!opts.GetPreserveOrder())
+                    {
+                        props.SortInPlace();
+                    }
+
                     foreach (string prop in props)
                     {
                         // copy keywords to output
@@ -1576,7 +1606,12 @@ private void Frame(JsonLdApi.FramingContext state, JObject nodes
                     }
                     // handle defaults
                     props = new JArray(frame.GetKeys());
-                    props.SortInPlace();
+
+                    if (!opts.GetPreserveOrder())
+                    {
+                        props.SortInPlace();
+                    }
+
                     foreach (string prop_1 in props)
                     {
                         // skip keywords
@@ -2116,7 +2151,12 @@ public virtual JArray FromRDF(RDFDataset dataset)
             JArray result = new JArray();
             // 6)
             JArray ids = new JArray(defaultGraph.GetKeys());
-            ids.SortInPlace();
+
+            if (!opts.GetPreserveOrder())
+            {
+                ids.SortInPlace();
+            }
+
             foreach (string subject_1 in ids)
             {
                 JsonLdApi.NodeMapNode node = (NodeMapNode)defaultGraph[subject_1];
@@ -2127,7 +2167,12 @@ public virtual JArray FromRDF(RDFDataset dataset)
                     node["@graph"] = new JArray();
                     // 6.1.2)
                     JArray keys = new JArray(graphMap[subject_1].GetKeys());
-                    keys.SortInPlace();
+
+                    if (!opts.GetPreserveOrder())
+                    {
+                        keys.SortInPlace();
+                    }
+
                     foreach (string s in keys)
                     {
                         JsonLdApi.NodeMapNode n = (NodeMapNode)graphMap[subject_1][s];

src/json-ld.net/Core/JsonLdOptions.cs

@@ -43,6 +43,8 @@ public virtual JsonLD.Core.JsonLdOptions Clone()
 
         private bool produceGeneralizedRdf = false;
 
+        private bool preserveOrder = false;
+
         // base options
         // frame options
         // rdf conversion options
@@ -147,6 +149,16 @@ public virtual void SetProduceGeneralizedRdf(bool produceGeneralizedRdf)
             this.produceGeneralizedRdf = produceGeneralizedRdf;
         }
 
+        public virtual bool GetPreserveOrder()
+        {
+            return preserveOrder;
+        }
+
+        public virtual void SetPreserveOrder(bool preserveOrder)
+        {
+            this.preserveOrder = preserveOrder;
+        }
+
         public string format = null;
 
         public bool useNamespaces = false;

src/json-ld.net/Core/JsonLdProcessor.cs

@@ -201,7 +201,12 @@ public static JToken Flatten(JToken input, JToken context, JsonLdOptions opts)
                     entry["@graph"] = new JArray();
                 }
                 JArray keys = new JArray(graph.GetKeys());
-                keys.SortInPlace();
+
+                if (!opts.GetPreserveOrder())
+                {
+                    keys.SortInPlace();
+                }
+
                 foreach (string id in keys)
                 {
                     JObject node = (JObject)graph[id];
@@ -215,7 +220,12 @@ public static JToken Flatten(JToken input, JToken context, JsonLdOptions opts)
             JArray flattened = new JArray();
             // 6)
             JArray keys_1 = new JArray(defaultGraph.GetKeys());
-            keys_1.SortInPlace();
+
+            if (!opts.GetPreserveOrder())
+            {
+                keys_1.SortInPlace();
+            }
+
             foreach (string id_1 in keys_1)
             {
                 JObject node = (JObject)defaultGraph[id_1