Add support for JsConfig.IncludeNullValuesInDictionaries

Author: mythz

src/ServiceStack.Text/Common/DeserializeListWithElements.cs

@@ -143,7 +143,14 @@ public static ICollection<T> ParseGenericList(string value, Type createListType,
                     do
                     {
                         var itemValue = Serializer.EatTypeValue(value, ref i);
-                        to.Add((T)parseFn(itemValue));
+                        if (itemValue != null)
+                        {
+                            to.Add((T)parseFn(itemValue));
+                        }
+                        else
+                        {
+                            to.Add(default(T));
+                        }
                         Serializer.EatWhitespace(value, ref i);
                     } while (++i < value.Length);
                 }

src/ServiceStack.Text/Common/ITypeSerializer.cs

@@ -7,6 +7,7 @@ namespace ServiceStack.Text.Common
     public interface ITypeSerializer
     {
         bool IncludeNullValues { get; }
+        bool IncludeNullValuesInDictionaries { get; }
         string TypeAttrInObject { get; }
 
         WriteObjectDelegate GetWriteFn<T>();

src/ServiceStack.Text/Common/WriteDictionary.cs

@@ -110,7 +110,7 @@ public static void WriteIDictionary(TextWriter writer, object oMap)
                 var dictionaryValue = map[key];
 
                 var isNull = (dictionaryValue == null);
-                if (isNull && !Serializer.IncludeNullValues) continue;
+                if (isNull && !Serializer.IncludeNullValuesInDictionaries) continue;
 
                 var keyType = key.GetType();
                 if (writeKeyFn == null || lastKeyType != keyType)
@@ -214,7 +214,7 @@ public static void WriteGenericIDictionary(
             foreach (var kvp in map)
             {
                 var isNull = (kvp.Value == null);
-                if (isNull && !Serializer.IncludeNullValues) continue;
+                if (isNull && !Serializer.IncludeNullValuesInDictionaries) continue;
 
                 JsWriter.WriteItemSeperatorIfRanOnce(writer, ref ranOnce);
 

src/ServiceStack.Text/JsConfig.cs

@@ -35,6 +35,7 @@ public static JsConfigScope With(
 			ParseAsType? parsePrimitiveIntegerTypes = null,
             bool? excludeDefaultValues = null,
             bool? includeNullValues = null,
+            bool? includeNullValuesInDictionaries = null,
             bool? includeDefaultEnums = null,
             bool? excludeTypeInfo = null,
             bool? includeTypeInfo = null,
@@ -70,6 +71,7 @@ public static JsConfigScope With(
 
                 ExcludeDefaultValues = excludeDefaultValues ?? sExcludeDefaultValues,
                 IncludeNullValues = includeNullValues ?? sIncludeNullValues,
+                IncludeNullValuesInDictionaries = includeNullValuesInDictionaries ?? sIncludeNullValuesInDictionaries,
                 IncludeDefaultEnums = includeDefaultEnums ?? sIncludeDefaultEnums,
                 ExcludeTypeInfo = excludeTypeInfo ?? sExcludeTypeInfo,
                 IncludeTypeInfo = includeTypeInfo ?? sIncludeTypeInfo,
@@ -201,6 +203,21 @@ public static bool IncludeNullValues
             }
         }
 
+        private static bool? sIncludeNullValuesInDictionaries;
+        public static bool IncludeNullValuesInDictionaries
+        {
+            get
+            {
+                return (JsConfigScope.Current != null ? JsConfigScope.Current.IncludeNullValuesInDictionaries : null)
+                    ?? sIncludeNullValuesInDictionaries
+                    ?? false;
+            }
+            set
+            {
+                if (!sIncludeNullValuesInDictionaries.HasValue) sIncludeNullValuesInDictionaries = value;
+            }
+        }
+
         private static bool? sIncludeDefaultEnums;
         public static bool IncludeDefaultEnums
         {
@@ -708,6 +725,7 @@ public static void Reset()
             sConvertObjectTypesIntoStringDictionary = null;
             sExcludeDefaultValues = null;
             sIncludeNullValues = null;
+            sIncludeNullValuesInDictionaries = null;
             sExcludeTypeInfo = null;
             sEmitCamelCaseNames = null;
             sEmitLowercaseUnderscoreNames = null;

src/ServiceStack.Text/JsConfigScope.cs

@@ -60,6 +60,7 @@ public void Dispose()
 		public ParseAsType? ParsePrimitiveIntegerTypes { get; set; }
         public bool? ExcludeDefaultValues { get; set; }
         public bool? IncludeNullValues { get; set; }
+        public bool? IncludeNullValuesInDictionaries { get; set; }
         public bool? IncludeDefaultEnums { get; set; }
         public bool? TreatEnumAsInteger { get; set; }
         public bool? ExcludeTypeInfo { get; set; }

src/ServiceStack.Text/Json/JsonTypeSerializer.cs

@@ -19,6 +19,11 @@ public bool IncludeNullValues
             get { return JsConfig.IncludeNullValues; }
         }
 
+        public bool IncludeNullValuesInDictionaries
+        {
+            get { return JsConfig.IncludeNullValuesInDictionaries; }
+        }
+
         public string TypeAttrInObject
         {
             get { return JsConfig.JsonTypeAttrInObject; }

src/ServiceStack.Text/Jsv/JsvTypeSerializer.cs

@@ -14,10 +14,15 @@ public class JsvTypeSerializer
 	{
 		public static ITypeSerializer Instance = new JsvTypeSerializer();
 
-	    public bool IncludeNullValues
-	    {
+        public bool IncludeNullValues
+        {
             get { return false; } //Doesn't support null values, treated as "null" string literal
-	    }
+        }
+
+        public bool IncludeNullValuesInDictionaries
+        {
+            get { return false; } //Doesn't support null values, treated as "null" string literal
+        }
 
         public string TypeAttrInObject
         {

tests/ServiceStack.Text.Tests/DictionaryTests.cs

@@ -414,7 +414,8 @@ public void Can_deserialize_mixed_dictionary_into_strongtyped_map()
         [Test]
         public void Can_serialise_null_values_from_dictionary_correctly()
         {
-            JsConfig.IncludeNullValues = true;
+            JsConfig.IncludeNullValues = false;
+            JsConfig.IncludeNullValuesInDictionaries = true;
             var dictionary = new Dictionary<string, object> { { "value", null } };
 
             Serialize(dictionary, includeXml: false);
@@ -429,7 +430,8 @@ public void Can_serialise_null_values_from_dictionary_correctly()
         [Test]
         public void Will_ignore_null_values_from_dictionary_correctly()
         {
-            JsConfig.IncludeNullValues = false;
+            JsConfig.IncludeNullValues = true;
+            JsConfig.IncludeNullValuesInDictionaries = false;
             var dictionary = new Dictionary<string, string> { { "value", null } };
 
             Serialize(dictionary, includeXml: false);

tests/ServiceStack.Text.Tests/ExpandoTests.cs

@@ -103,7 +103,7 @@ public void Can_deserialize_two_level_expando()
         [Test]
         public void Can_serialise_null_values_from_expando_correctly()
         {
-            JsConfig.IncludeNullValues = true;
+            JsConfig.IncludeNullValuesInDictionaries = true;
             dynamic expando = new ExpandoObject();
             expando.value = null;
 

tests/ServiceStack.Text.Tests/JsonTests/JsonArrayObjectTests.cs

@@ -135,5 +135,30 @@ public void Can_deserialize_empty_array_with_whitespace()
             var result = data.FromJson<Test[]>();
             Assert.That(result.Length, Is.EqualTo(0));
         }
+
+        public class MyClass
+        {
+            public string Item { get; set; }
+        }
+
+        [Test]
+        public void Can_parse_array_with_null_objects_starting_with_not_null_item()
+        {
+            var compactJson = @"{""items"":[{""Item"":""myitem""},null]}";
+            var json = JsonObject.Parse(compactJson);
+            var items = json.ArrayObjects("items");
+            Assert.NotNull(items[0]);
+            Assert.Null(items[1]);
+        }
+
+        [Test]
+        public void Can_parse_array_with_null_objects_starting_with_null_item()
+        {
+            var compactJson = @"{""items"":[null,{""Item"":""myitem""}]}";
+            var json = JsonObject.Parse(compactJson);
+            var items = json.ArrayObjects("items");
+            Assert.Null(items[0]);
+            Assert.NotNull(items[1]);
+        }
     }
 }