Add JsConfig.IncludeDefaultEnums

Author: mythz

src/ServiceStack.Text/Common/WriteType.cs

@@ -172,7 +172,8 @@ private static bool Init()
                     propertyInfo.GetValueGetter<T>(),
                     Serializer.GetWriteFn(propertyType),
                     propertyType.GetDefaultValue(),
-                    shouldSerialize
+                    shouldSerialize,
+                    propertyType.IsEnum()
                 );
             }
 
@@ -223,7 +224,8 @@ private static bool Init()
                     fieldInfo.GetValueGetter<T>(),
                     Serializer.GetWriteFn(propertyType),
                     defaultValue,
-                    shouldSerialize
+                    shouldSerialize,
+                    propertyType.IsEnum()
                 );
             }
 
@@ -255,10 +257,11 @@ internal string PropertyName
             internal readonly WriteObjectDelegate WriteFn;
             internal readonly object DefaultValue;
             internal readonly Func<T, bool> shouldSerialize;
+            internal readonly bool isEnum;
 
             public TypePropertyWriter(string propertyName, string propertyDeclaredTypeName, string propertyNameCLSFriendly, 
                 string propertyNameLowercaseUnderscore, int propertyOrder, bool propertySuppressDefaultConfig,bool propertySuppressDefaultAttribute,
-                Func<T, object> getterFn, WriteObjectDelegate writeFn, object defaultValue, Func<T, bool> shouldSerialize)
+                Func<T, object> getterFn, WriteObjectDelegate writeFn, object defaultValue, Func<T, bool> shouldSerialize, bool isEnum)
             {
                 this.propertyName = propertyName;
                 this.propertyOrder = propertyOrder;
@@ -271,6 +274,25 @@ public TypePropertyWriter(string propertyName, string propertyDeclaredTypeName,
                 this.WriteFn = writeFn;
                 this.DefaultValue = defaultValue;
                 this.shouldSerialize = shouldSerialize;
+                this.isEnum = isEnum;
+            }
+
+            public bool ShouldWriteProperty(object propertyValue)
+            {
+                if (propertySuppressDefaultAttribute && Equals(DefaultValue, propertyValue))
+                    return false;
+
+                if (!Serializer.IncludeNullValues
+                    && (propertyValue == null
+                        || (propertySuppressDefaultConfig && Equals(DefaultValue, propertyValue))))
+                {
+                    return false;
+                }
+
+                if (isEnum && !JsConfig.IncludeDefaultEnums && Equals(DefaultValue, propertyValue))
+                    return false;
+
+                return true;
             }
         }
 
@@ -336,23 +358,15 @@ public static void WriteProperties(TextWriter writer, object value)
                 {
                     var propertyWriter = PropertyWriters[index];
 
-                    if (propertyWriter.shouldSerialize != null && !propertyWriter.shouldSerialize((T)value)) continue;
+                    if (propertyWriter.shouldSerialize != null && !propertyWriter.shouldSerialize((T)value)) 
+                        continue;
 
                     var propertyValue = value != null
                         ? propertyWriter.GetterFn((T)value)
                         : null;
 
-                    if (propertyWriter.propertySuppressDefaultAttribute && Equals(propertyWriter.DefaultValue, propertyValue))
-                    {
-                        continue;
-                    }
-                    if ((propertyValue == null 
-                         || (propertyWriter.propertySuppressDefaultConfig && Equals(propertyWriter.DefaultValue, propertyValue)))
-                        && !Serializer.IncludeNullValues
-                        )
-                    {
+                    if (!propertyWriter.ShouldWriteProperty(propertyValue))
                         continue;
-                    }
 
                     if (JsConfig.ExcludePropertyReferences != null
                         && JsConfig.ExcludePropertyReferences.Contains(propertyWriter.propertyReferenceName)) continue;

src/ServiceStack.Text/JsConfig.cs

@@ -31,6 +31,7 @@ public static JsConfigScope With(
             bool? tryToParsePrimitiveTypeValues = null,
 			bool? tryToParseNumericType = null,
             bool? includeNullValues = null,
+            bool? includeDefaultEnums = null,
             bool? excludeTypeInfo = null,
             bool? includeTypeInfo = null,
             bool? emitCamelCaseNames = null,
@@ -58,6 +59,7 @@ public static JsConfigScope With(
                 TryToParsePrimitiveTypeValues = tryToParsePrimitiveTypeValues ?? sTryToParsePrimitiveTypeValues,
                 TryToParseNumericType = tryToParseNumericType ?? sTryToParseNumericType,
                 IncludeNullValues = includeNullValues ?? sIncludeNullValues,
+                IncludeDefaultEnums = includeDefaultEnums ?? sIncludeDefaultEnums,
                 ExcludeTypeInfo = excludeTypeInfo ?? sExcludeTypeInfo,
                 IncludeTypeInfo = includeTypeInfo ?? sIncludeTypeInfo,
                 EmitCamelCaseNames = emitCamelCaseNames ?? sEmitCamelCaseNames,
@@ -132,8 +134,8 @@ public static bool IncludeNullValues
         {
             get
             {
-                return (JsConfigScope.Current != null ? JsConfigScope.Current.IncludeNullValues: null)
-                    ?? sIncludeNullValues 
+                return (JsConfigScope.Current != null ? JsConfigScope.Current.IncludeNullValues : null)
+                    ?? sIncludeNullValues
                     ?? false;
             }
             set
@@ -142,6 +144,21 @@ public static bool IncludeNullValues
             }
         }
 
+        private static bool? sIncludeDefaultEnums;
+        public static bool IncludeDefaultEnums
+        {
+            get
+            {
+                return (JsConfigScope.Current != null ? JsConfigScope.Current.IncludeDefaultEnums : null)
+                    ?? sIncludeDefaultEnums
+                    ?? true;
+            }
+            set
+            {
+                if (!sIncludeDefaultEnums.HasValue) sIncludeDefaultEnums = value;
+            }
+        }
+
         private static bool? sTreatEnumAsInteger;
         public static bool TreatEnumAsInteger
         {

src/ServiceStack.Text/JsConfigScope.cs

@@ -56,6 +56,7 @@ public void Dispose()
         public bool? TryToParsePrimitiveTypeValues { get; set; }
 		public bool? TryToParseNumericType { get; set; }
         public bool? IncludeNullValues { get; set; }
+        public bool? IncludeDefaultEnums { get; set; }
         public bool? TreatEnumAsInteger { get; set; }
         public bool? ExcludeTypeInfo { get; set; }
         public bool? IncludeTypeInfo { get; set; }

tests/ServiceStack.Text.Tests/EnumTests.cs

@@ -15,13 +15,15 @@ public void SetUp()
 
         public enum EnumWithoutFlags
         {
+            Zero = 0,
             One = 1,
             Two = 2
         }
 
         [Flags]
         public enum EnumWithFlags
         {
+            Zero = 0,
             One = 1,
             Two = 2
         }
@@ -51,6 +53,24 @@ public void Can_correctly_serialize_enums()
             Assert.AreEqual(expected, text);
         }
 
+        [Test]
+        public void Can_exclude_default_enums()
+        {
+            var item = new ClassWithEnums
+            {
+                FlagsEnum = EnumWithFlags.Zero,
+                NoFlagsEnum = EnumWithoutFlags.One,
+            };
+
+            Assert.That(item.ToJson(), Is.EqualTo("{\"FlagsEnum\":0,\"NoFlagsEnum\":\"One\"}"));
+
+            JsConfig.IncludeDefaultEnums = false;
+
+            Assert.That(item.ToJson(), Is.EqualTo("{\"NoFlagsEnum\":\"One\"}"));
+
+            JsConfig.Reset();
+        }
+
         public void Should_deserialize_enum()
         {
             Assert.That(JsonSerializer.DeserializeFromString<EnumWithoutFlags>("\"Two\""), Is.EqualTo(EnumWithoutFlags.Two));
@@ -114,7 +134,6 @@ public void Can_use_enum_as_key_in_map()
             var map = json.FromJson<Dictionary<AnEnum, int>>();
             Assert.That(map[AnEnum.This], Is.EqualTo(1));
         }
-
     }
 }