Add Obsolete settings (#37)

VerifyTests · Feb 2, 2020 · bc6bd61 · bc6bd61
1 parent 5e75bbd
commit bc6bd61
Show file tree

Hide file tree

Showing 8 changed files with 166 additions and 16 deletions.
diff --git a/docs/mdsource/serializer-settings.source.md b/docs/mdsource/serializer-settings.source.md
@@ -119,6 +119,29 @@ Result:
 snippet: Tests.AddIgnoreInstance.verified.txt
 
 
+## Obsolete members ignored
+
+Members with an [ObsoleteAttribute](https://docs.microsoft.com/en-us/dotnet/api/system.obsoleteattribute) are ignored:
+
+snippet: WithObsoleteProp
+
+Result:
+
+snippet: Tests.WithObsoleteProp.verified.txt
+
+
+## Including Obsolete members
+
+Obsolete members can be included using `IncludeObsoletes`:
+
+snippet: WithObsoletePropIncluded
+
+Result:
+
+snippet: Tests.WithObsoletePropIncluded.verified.txt
+
+
+
 ## Ignore member by expressions
 
 To ignore members of a certain type using an expression:

diff --git a/docs/serializer-settings.md b/docs/serializer-settings.md
@@ -28,6 +28,8 @@ Serialization settings can be customized at three levels:
   * [Scoped settings](#scoped-settings)
   * [Ignoring a type](#ignoring-a-type)
   * [Ignoring a instance](#ignoring-a-instance)
+  * [Obsolete members ignored](#obsolete-members-ignored)
+  * [Including Obsolete members](#including-obsolete-members)
   * [Ignore member by expressions](#ignore-member-by-expressions)
   * [Ignore member by name](#ignore-member-by-name)
   * [Members that throw](#members-that-throw)<!-- endtoc -->
@@ -47,7 +49,7 @@ var settings = new JsonSerializerSettings
     DefaultValueHandling = DefaultValueHandling.Ignore
 };
 ```
-<sup><a href='/src/Verify/Serialization/SerializationSettings.cs#L152-L161' title='File snippet `defaultserialization` was extracted from'>snippet source</a> | <a href='#snippet-defaultserialization' title='Navigate to start of snippet `defaultserialization`'>anchor</a></sup>
+<sup><a href='/src/Verify/Serialization/SerializationSettings.cs#L153-L162' title='File snippet `defaultserialization` was extracted from'>snippet source</a> | <a href='#snippet-defaultserialization' title='Navigate to start of snippet `defaultserialization`'>anchor</a></sup>
 <!-- endsnippet -->
 
 
@@ -144,7 +146,7 @@ var target = new DateTimeTarget
 
 await Verify(target);
 ```
-<sup><a href='/src/Verify.Tests/Tests.cs#L557-L573' title='File snippet `date` was extracted from'>snippet source</a> | <a href='#snippet-date' title='Navigate to start of snippet `date`'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Tests.cs#L581-L597' title='File snippet `date` was extracted from'>snippet source</a> | <a href='#snippet-date' title='Navigate to start of snippet `date`'>anchor</a></sup>
 <!-- endsnippet -->
 
 Results in the following:
@@ -360,6 +362,85 @@ Result:
 <!-- endsnippet -->
 
 
+## Obsolete members ignored
+
+Members with an [ObsoleteAttribute](https://docs.microsoft.com/en-us/dotnet/api/system.obsoleteattribute) are ignored:
+
+<!-- snippet: WithObsoleteProp -->
+<a id='snippet-withobsoleteprop'/></a>
+```cs
+class WithObsolete
+{
+    [Obsolete]
+    public string ObsoleteProperty { get; set; }
+    public string OtherProperty { get; set; }
+}
+
+[Fact]
+public Task WithObsoleteProp()
+{
+    var target = new WithObsolete
+    {
+        ObsoleteProperty = "value1",
+        OtherProperty = "value2"
+    };
+    return Verify(target);
+}
+```
+<sup><a href='/src/Verify.Tests/Tests.cs#L384-L404' title='File snippet `withobsoleteprop` was extracted from'>snippet source</a> | <a href='#snippet-withobsoleteprop' title='Navigate to start of snippet `withobsoleteprop`'>anchor</a></sup>
+<!-- endsnippet -->
+
+Result:
+
+<!-- snippet: Tests.WithObsoleteProp.verified.txt -->
+<a id='snippet-Tests.WithObsoleteProp.verified.txt'/></a>
+```txt
+{
+  OtherProperty: 'value2'
+}
+```
+<sup><a href='/src/Verify.Tests/Tests.WithObsoleteProp.verified.txt#L1-L3' title='File snippet `Tests.WithObsoleteProp.verified.txt` was extracted from'>snippet source</a> | <a href='#snippet-Tests.WithObsoleteProp.verified.txt' title='Navigate to start of snippet `Tests.WithObsoleteProp.verified.txt`'>anchor</a></sup>
+<!-- endsnippet -->
+
+
+## Including Obsolete members
+
+Obsolete members can be included using `IncludeObsoletes`:
+
+<!-- snippet: WithObsoletePropIncluded -->
+<a id='snippet-withobsoletepropincluded'/></a>
+```cs
+[Fact]
+public Task WithObsoletePropIncluded()
+{
+    var target = new WithObsolete
+    {
+        ObsoleteProperty = "value1",
+        OtherProperty = "value2"
+    };
+    var settings = new VerifySettings();
+    settings.ModifySerialization(_=> { _.IncludeObsoletes(); });
+    return Verify(target, settings);
+}
+```
+<sup><a href='/src/Verify.Tests/Tests.cs#L406-L421' title='File snippet `withobsoletepropincluded` was extracted from'>snippet source</a> | <a href='#snippet-withobsoletepropincluded' title='Navigate to start of snippet `withobsoletepropincluded`'>anchor</a></sup>
+<!-- endsnippet -->
+
+Result:
+
+<!-- snippet: Tests.WithObsoletePropIncluded.verified.txt -->
+<a id='snippet-Tests.WithObsoletePropIncluded.verified.txt'/></a>
+```txt
+{
+  ObsoleteProperty: 'value1',
+  OtherProperty: 'value2'
+}
+```
+<sup><a href='/src/Verify.Tests/Tests.WithObsoletePropIncluded.verified.txt#L1-L4' title='File snippet `Tests.WithObsoletePropIncluded.verified.txt` was extracted from'>snippet source</a> | <a href='#snippet-Tests.WithObsoletePropIncluded.verified.txt' title='Navigate to start of snippet `Tests.WithObsoletePropIncluded.verified.txt`'>anchor</a></sup>
+<!-- endsnippet -->
+
+
+
 ## Ignore member by expressions
 
 To ignore members of a certain type using an expression:

diff --git a/src/Verify.Tests/Tests.WithObsoleteProp.verified.txt b/src/Verify.Tests/Tests.WithObsoleteProp.verified.txt
@@ -1 +1,3 @@
-{}
+{
+  OtherProperty: 'value2'
+}
diff --git a/src/Verify.Tests/Tests.WithObsoletePropIncluded.verified.txt b/src/Verify.Tests/Tests.WithObsoletePropIncluded.verified.txt
@@ -0,0 +1,4 @@
+{
+  ObsoleteProperty: 'value1',
+  OtherProperty: 'value2'
+}
diff --git a/src/Verify.Tests/Tests.cs b/src/Verify.Tests/Tests.cs
@@ -378,26 +378,50 @@ class WithNotSupportedException
     {
         public Guid NotImplementedExceptionProperty => throw new NotSupportedException();
     }
+
+#pragma warning disable 612
+
+    #region WithObsoleteProp
+
+    class WithObsolete
+    {
+        [Obsolete]
+        public string ObsoleteProperty { get; set; }
+        public string OtherProperty { get; set; }
+    }
 
     [Fact]
     public Task WithObsoleteProp()
     {
-        var target = new WithObsolete();
+        var target = new WithObsolete
+        {
+            ObsoleteProperty = "value1",
+            OtherProperty = "value2"
+        };
         return Verify(target);
     }
 
-    class WithObsolete
-    {
-        Guid obsoleteProperty;
+    #endregion
 
-        [Obsolete]
-        public Guid ObsoleteProperty
+    #region WithObsoletePropIncluded
+
+    [Fact]
+    public Task WithObsoletePropIncluded()
+    {
+        var target = new WithObsolete
         {
-            get { throw new NotImplementedException(); }
-            set => obsoleteProperty = value;
-        }
+            ObsoleteProperty = "value1",
+            OtherProperty = "value2"
+        };
+        var settings = new VerifySettings();
+        settings.ModifySerialization(_=> { _.IncludeObsoletes(); });
+        return Verify(target, settings);
     }
 
+    #endregion
+
+#pragma warning restore 612
+
     [Fact]
     public Task Escaping()
     {

diff --git a/src/Verify/Serialization/CustomContractResolver.cs b/src/Verify/Serialization/CustomContractResolver.cs
@@ -11,6 +11,7 @@ class CustomContractResolver :
 {
     bool ignoreEmptyCollections;
     bool ignoreFalse;
+    bool includeObsoletes;
     IReadOnlyDictionary<Type, List<string>> ignored;
     IReadOnlyList<Type> ignoredTypes;
     IReadOnlyList<Func<Exception, bool>> ignoreMembersThatThrow;
@@ -19,6 +20,7 @@ class CustomContractResolver :
     public CustomContractResolver(
         bool ignoreEmptyCollections,
         bool ignoreFalse,
+        bool includeObsoletes,
         IReadOnlyDictionary<Type, List<string>> ignored,
         IReadOnlyList<Type> ignoredTypes,
         IReadOnlyList<Func<Exception, bool>> ignoreMembersThatThrow,
@@ -29,6 +31,7 @@ class CustomContractResolver :
         Guard.AgainstNull(ignoreMembersThatThrow, nameof(ignoreMembersThatThrow));
         this.ignoreEmptyCollections = ignoreEmptyCollections;
         this.ignoreFalse = ignoreFalse;
+        this.includeObsoletes = includeObsoletes;
         this.ignored = ignored;
         this.ignoredTypes = ignoredTypes;
         this.ignoreMembersThatThrow = ignoreMembersThatThrow;
@@ -52,10 +55,13 @@ protected override JsonProperty CreateProperty(MemberInfo member, MemberSerializ
 
         property.ConfigureIfBool(member, ignoreFalse);
 
-        if (member.GetCustomAttribute<ObsoleteAttribute>(true) != null)
+        if (!includeObsoletes)
         {
-            property.Ignored = true;
-            return property;
+            if (member.GetCustomAttribute<ObsoleteAttribute>(true) != null)
+            {
+                property.Ignored = true;
+                return property;
+            }
         }
 
         if (ignoredTypes.Any(x => x.IsAssignableFrom(property.PropertyType)))

diff --git a/src/Verify/Serialization/SerializationSettings.cs b/src/Verify/Serialization/SerializationSettings.cs
@@ -35,7 +35,8 @@ public SerializationSettings Clone()
                 ignoreMembersWithType = ignoreMembersWithType.Clone(),
                 ignoredInstances = ignoredInstances.Clone(),
                 scrubDateTimes = scrubDateTimes,
-                scrubGuids = scrubGuids
+                scrubGuids = scrubGuids,
+                includeObsoletes = includeObsoletes,
             };
         }
 
@@ -164,6 +165,7 @@ public JsonSerializerSettings BuildSettings()
             settings.ContractResolver = new CustomContractResolver(
                 ignoreEmptyCollections,
                 ignoreFalse,
+                includeObsoletes,
                 ignoredMembers,
                 ignoreMembersWithType,
                 ignoreMembersThatThrow,
@@ -224,5 +226,12 @@ internal void RegenSettings()
         {
             currentSettings = BuildSettings();
         }
+
+        bool includeObsoletes;
+
+        public void IncludeObsoletes()
+        {
+            includeObsoletes = true;
+        }
     }
 }
diff --git a/src/Verify/Serialization/VerifySettings.cs b/src/Verify/Serialization/VerifySettings.cs
@@ -31,5 +31,6 @@ public void AddExtraSettings(Action<JsonSerializerSettings> action)
             serialization.AddExtraSettings(action);
             serialization.RegenSettings();
         }
+
     }
 }