Merge pull request #94 from sescalada/ignore-nulls

Add option to serializer settings to ignore null values
xoofx · Mar 6, 2022 · 3dbe70b · 3dbe70b
2 parents d41ce9b + 895facf
commit 3dbe70b
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 1 deletion.
diff --git a/src/SharpYaml.Tests/Serialization/SerializationTests2.cs b/src/SharpYaml.Tests/Serialization/SerializationTests2.cs
@@ -1543,6 +1543,36 @@ public class ClassWithImplicitMemberTypeInner
             public string String { get; set; }
         }
 
+        [Test]
+        public void TestIgnoreNulls()
+        {
+            var serializer = new Serializer();
+            serializer.Settings.IgnoreNulls = true;
+            var testObject = new ClassToIgnoreNulls()
+            {
+                Id = 10,
+                Nullable = 3,
+            };
+
+            var text = serializer.Serialize(testObject);
+            Assert.False(text.Contains("DontSerializeWhenNull: null"));
+
+            var deserialized = serializer.Deserialize(new StringReader(text)) as ClassToIgnoreNulls;
+            Assert.NotNull(deserialized);
+            Assert.AreEqual(testObject.Id, deserialized.Id);
+            Assert.Null(deserialized.DontSerializeWhenNull);
+            Assert.AreEqual(testObject.Nullable, deserialized.Nullable);
+        }
+
+        public class ClassToIgnoreNulls
+        {
+            public int Id { get; set; }
+
+            public string DontSerializeWhenNull { get; set; }
+
+            public int? Nullable { get; set; }
+        }
+
         private void SerialRoundTrip(SerializerSettings settings, string text, Type serializedType = null)
         {
             var serializer = new Serializer(settings);

diff --git a/src/SharpYaml/Serialization/SerializerSettings.cs b/src/SharpYaml/Serialization/SerializerSettings.cs
@@ -195,6 +195,11 @@ public bool EmitJsonComptible
         /// <value><c>true</c> if to emit default value; otherwise, <c>false</c>.</value>
         public bool RespectPrivateSetters { get; set; }
 
+        /// <summary>
+        /// Gets or sets a value indicating whether to ignore serialization of properties with null values. Default is false.
+        /// </summary>
+        public bool IgnoreNulls { get; set; }
+
         /// <summary>
         /// Gets or sets the default key comparer used to sort members (<see cref="IMemberDescriptor"/>) or
         /// dictionary keys, when serializing objects as YAML mappings. Default is <see cref="DefaultKeyComparer"/>. 

diff --git a/src/SharpYaml/Serialization/Serializers/ObjectSerializer.cs b/src/SharpYaml/Serialization/Serializers/ObjectSerializer.cs
@@ -406,10 +406,13 @@ protected virtual void WriteMember(ref ObjectContext objectContext, IMemberDescr
             if (!member.ShouldSerialize(objectContext.Instance))
                 return;
 
+            var memberValue = member.Get(objectContext.Instance);
+            if (memberValue == null && objectContext.Settings.IgnoreNulls)
+                return;
+
             // Emit the key name
             WriteMemberName(ref objectContext, member, member.Name);
 
-            var memberValue = member.Get(objectContext.Instance);
             var memberType = member.Type;
 
             // In case of serializing a property/field which is not writeable