drop support for null as the root object (#660)

docs/parameterised.md

@@ -164,7 +164,7 @@ public class ComplexParametersSample
 
     [Theory]
     [MemberData(nameof(GetComplexMemberData))]
-    public Task ComplexMemberNullableData(ComplexData? arg)
+    public Task ComplexMemberNullableData(ComplexData arg)
     {
         var settings = new VerifySettings();
         settings.UseParameters(arg);
@@ -173,7 +173,7 @@ public class ComplexParametersSample
 
     [Theory]
     [MemberData(nameof(GetComplexMemberData))]
-    public Task ComplexMemberNullableDataFluent(ComplexData? arg) =>
+    public Task ComplexMemberNullableDataFluent(ComplexData arg) =>
         Verify(arg)
             .UseParameters(arg);
 
@@ -211,7 +211,7 @@ public class ComplexParametersSample
 
     [Theory]
     [MemberData(nameof(GetComplexMemberStructData))]
-    public Task ComplexMemberNullableStructData(ComplexStructData? arg)
+    public Task ComplexMemberNullableStructData(ComplexStructData arg)
     {
         var settings = new VerifySettings();
         settings.UseParameters(arg);
@@ -220,7 +220,7 @@ public class ComplexParametersSample
 
     [Theory]
     [MemberData(nameof(GetComplexMemberStructData))]
-    public Task ComplexMemberNullableStructDataFluent(ComplexStructData? arg) =>
+    public Task ComplexMemberNullableStructDataFluent(ComplexStructData arg) =>
         Verify(arg)
             .UseParameters(arg);
 

docs/serializer-settings.md

@@ -1592,7 +1592,7 @@ The default mapping is:
     }
 }
 ```
-<sup><a href='/src/Verify/Serialization/VerifierSettings.cs#L44-L136' title='Snippet source file'>snippet source</a> | <a href='#snippet-typetostringmapping' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify/Serialization/VerifierSettings.cs#L38-L130' title='Snippet source file'>snippet source</a> | <a href='#snippet-typetostringmapping' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 This bypasses the Guid and DateTime scrubbing mentioned above.
@@ -1750,7 +1750,7 @@ If the target is a stream or binary file:
 public Task Stream() =>
     Verify(IoHelpers.OpenRead("sample.txt"));
 ```
-<sup><a href='/src/Verify.Tests/Converters/JsonAppenderTests.cs#L69-L75' title='Snippet source file'>snippet source</a> | <a href='#snippet-jsonappenderstream' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Converters/JsonAppenderTests.cs#L65-L71' title='Snippet source file'>snippet source</a> | <a href='#snippet-jsonappenderstream' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 Then the appended content will be added to the `.verified.txt` file:

readme.md

@@ -447,7 +447,7 @@ var result = await Verify(
     });
 Assert.Contains("Value To Check", result.Text);
 ```
-<sup><a href='/src/Verify.Tests/Tests.cs#L596-L605' title='Snippet source file'>snippet source</a> | <a href='#snippet-verifyresult' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Tests.cs#L584-L593' title='Snippet source file'>snippet source</a> | <a href='#snippet-verifyresult' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 If using `Verifier.Throws`, the resulting `Exception` will also be accessible
@@ -458,7 +458,7 @@ If using `Verifier.Throws`, the resulting `Exception` will also be accessible
 var result = await Verifier.Throws(MethodThatThrows);
 Assert.NotNull(result.Exception);
 ```
-<sup><a href='/src/Verify.Tests/Tests.cs#L640-L645' title='Snippet source file'>snippet source</a> | <a href='#snippet-exceptionresult' title='Start of snippet'>anchor</a></sup>
+<sup><a href='/src/Verify.Tests/Tests.cs#L628-L633' title='Snippet source file'>snippet source</a> | <a href='#snippet-exceptionresult' title='Start of snippet'>anchor</a></sup>
 <!-- endSnippet -->
 
 

src/Verify.Expecto/Verifier.cs

@@ -46,7 +46,7 @@ static async Task<VerifyResult> Verify(
 
     public static Task<VerifyResult> Verify(
         string name,
-        object? target,
+        object target,
         IEnumerable<Target> rawTargets,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "")

src/Verify.Expecto/Verifier_Directory.cs

@@ -24,7 +24,7 @@ public static Task<VerifyResult> VerifyDirectory(
 
     /// <summary>
     /// Verifies the contents of <param name="path"/>.
-    /// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
+    /// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object target)</code> which will verify the full path.
     /// </summary>
     public static Task<VerifyResult> VerifyDirectory(
         string name,
@@ -56,7 +56,7 @@ public static Task<VerifyResult> VerifyDirectory(
 
     /// <summary>
     /// Verifies the contents of <param name="path"/>.
-    /// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object? target)</code> which will verify the full path.
+    /// Differs from passing <see cref="DirectoryInfo"/> to <code>Verify(object target)</code> which will verify the full path.
     /// </summary>
     public static Task<VerifyResult> VerifyDirectory(
         string name,

src/Verify.Expecto/Verifier_Json.cs

@@ -9,6 +9,7 @@ public static Task<VerifyResult> Verify<T>(
         Task<T> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "")
+        where T : notnull
     {
         var assembly = Assembly.GetCallingAssembly()!;
         return Verify(settings, assembly, sourceFile, name, _ => _.Verify(target));
@@ -19,6 +20,7 @@ public static Task<VerifyResult> Verify<T>(
         ValueTask<T> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "")
+        where T : notnull
     {
         var assembly = Assembly.GetCallingAssembly()!;
         return Verify(settings, assembly, sourceFile, name, _ => _.Verify(target));
@@ -29,14 +31,15 @@ public static Task<VerifyResult> Verify<T>(
         IAsyncEnumerable<T> target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "")
+        where T : notnull
     {
         var assembly = Assembly.GetCallingAssembly()!;
         return Verify(settings, assembly, sourceFile, name, _ => _.Verify(target));
     }
 
     public static Task<VerifyResult> Verify(
         string name,
-        object? target,
+        object target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "")
     {

src/Verify.MSTest/VerifyBase.cs

@@ -47,7 +47,7 @@ InnerVerifier BuildVerifier(VerifySettings settings, string sourceFile, bool use
     }
 
     public SettingsTask Verify(
-        object? target,
+        object target,
         IEnumerable<Target> rawTargets,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>

src/Verify.MSTest/VerifyBase_Json.cs

@@ -5,23 +5,26 @@ public partial class VerifyBase
     public SettingsTask Verify<T>(
         Task<T> target,
         VerifySettings? settings = null,
-        [CallerFilePath] string sourceFile = "") =>
+        [CallerFilePath] string sourceFile = "")
+        where T : notnull =>
         Verify(settings, sourceFile, _ => _.Verify(target));
 
     public SettingsTask Verify<T>(
         ValueTask<T> target,
         VerifySettings? settings = null,
-        [CallerFilePath] string sourceFile = "") =>
+        [CallerFilePath] string sourceFile = "")
+        where T : notnull =>
         Verify(settings, sourceFile, _ => _.Verify(target));
 
     public SettingsTask Verify<T>(
         IAsyncEnumerable<T> target,
         VerifySettings? settings = null,
-        [CallerFilePath] string sourceFile = "") =>
+        [CallerFilePath] string sourceFile = "")
+        where T : notnull =>
         Verify(settings, sourceFile, _ => _.Verify(target));
 
     public SettingsTask Verify(
-        object? target,
+        object target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.Verify(target));

src/Verify.NUnit/Verifier.cs

@@ -104,7 +104,7 @@ static SettingsTask Verify(
     }
 
     public static SettingsTask Verify(
-        object? target,
+        object target,
         IEnumerable<Target> rawTargets,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>

src/Verify.NUnit/Verifier_Json.cs

@@ -5,23 +5,26 @@ public static partial class Verifier
     public static SettingsTask Verify<T>(
         Task<T> target,
         VerifySettings? settings = null,
-        [CallerFilePath] string sourceFile = "") =>
+        [CallerFilePath] string sourceFile = "")
+        where T : notnull =>
         Verify(settings, sourceFile, _ => _.Verify(target));
 
     public static SettingsTask Verify<T>(
         ValueTask<T> target,
         VerifySettings? settings = null,
-        [CallerFilePath] string sourceFile = "") =>
+        [CallerFilePath] string sourceFile = "")
+        where T : notnull =>
         Verify(settings, sourceFile, _ => _.Verify(target));
 
     public static SettingsTask Verify<T>(
         IAsyncEnumerable<T> target,
         VerifySettings? settings = null,
-        [CallerFilePath] string sourceFile = "") =>
+        [CallerFilePath] string sourceFile = "")
+        where T : notnull =>
         Verify(settings, sourceFile, _ => _.Verify(target));
 
     public static SettingsTask Verify(
-        object? target,
+        object target,
         VerifySettings? settings = null,
         [CallerFilePath] string sourceFile = "") =>
         Verify(settings, sourceFile, _ => _.Verify(target));

src/Verify.NUnit/VerifyBase.cs

@@ -18,7 +18,7 @@ public VerifyBase(VerifySettings? settings = null, [CallerFilePath] string sourc
     }
 
     public SettingsTask Verify(
-        object? target,
+        object target,
         IEnumerable<Target> rawTargets,
         VerifySettings? settings = null)
     {

src/Verify.NUnit/VerifyBase_Json.cs

@@ -5,6 +5,7 @@ public partial class VerifyBase
     public SettingsTask Verify<T>(
         Task<T> target,
         VerifySettings? settings = null)
+        where T : notnull
     {
         settings ??= this.settings;
         return Verifier.Verify(target, settings, sourceFile);
@@ -13,6 +14,7 @@ public SettingsTask Verify<T>(
     public SettingsTask Verify<T>(
         ValueTask<T> target,
         VerifySettings? settings = null)
+        where T : notnull
     {
         settings ??= this.settings;
         return Verifier.Verify(target, settings, sourceFile);
@@ -21,13 +23,14 @@ public SettingsTask Verify<T>(
     public SettingsTask Verify<T>(
         IAsyncEnumerable<T> target,
         VerifySettings? settings = null)
+        where T : notnull
     {
         settings ??= this.settings;
         return Verifier.Verify(target, settings, sourceFile);
     }
 
     public SettingsTask Verify(
-        object? target,
+        object target,
         VerifySettings? settings = null)
     {
         settings ??= this.settings;

src/Verify.Tests/Converters/FileAppenderTests.cs

@@ -27,10 +27,6 @@ public void Dispose() =>
     public Task Text() =>
         Verify("Foo");
 
-    [Fact]
-    public Task NullText() =>
-        Verify((string) null!);
-
     [Fact]
     public Task EmptyString() =>
         Verify(string.Empty);

src/Verify.Tests/Converters/JsonAppenderTests.cs

@@ -55,10 +55,6 @@ public Task WithDuplicate() =>
             .AppendValue("duplicate", "value1")
             .AppendValue("duplicate", "value2");
 
-    [Fact]
-    public Task NullText() =>
-        Verify((string) null!);
-
     [Fact]
     public Task Anon() =>
         Verify(new

src/Verify.Tests/Naming/NamerTests.MultipleTarget#02.verified.txt

@@ -0,0 +1 @@
+

src/Verify.Tests/Naming/NamerTests.SingleTarget#00.verified.txt

@@ -0,0 +1 @@
+

src/Verify.Tests/Naming/NamerTests.SingleTarget#01.verified.txt

@@ -0,0 +1 @@
+

src/Verify.Tests/Naming/NamerTests.cs

@@ -484,7 +484,6 @@ public Task IgnoreParametersForVerified()
     [Fact]
     public Task SingleTarget() =>
         Verify(
-            null,
             new[]
             {
                 new Target("txt", "data")
@@ -493,7 +492,6 @@ public Task SingleTarget() =>
     [Fact]
     public Task SingleTargetWithName() =>
         Verify(
-            null,
             new[]
             {
                 new Target("txt", "data", "theNameA")
@@ -502,7 +500,6 @@ public Task SingleTargetWithName() =>
     [Fact]
     public Task MultipleTarget() =>
         Verify(
-            null,
             new[]
             {
                 new Target("txt", "data"),
@@ -512,7 +509,6 @@ public Task MultipleTarget() =>
     [Fact]
     public Task MultipleTargetWithName() =>
         Verify(
-            null,
             new[]
             {
                 new Target("txt", "data", "theNameA"),
@@ -522,7 +518,6 @@ public Task MultipleTargetWithName() =>
     [Fact]
     public Task MultipleTargetWithDuplicateName() =>
         Verify(
-            null,
             new[]
             {
                 new Target("txt", "data", "theNameA"),

src/Verify.Tests/Serialization/SerializationTests.cs

@@ -2329,7 +2329,7 @@ public Task SetProperty()
     [Fact]
     public Task Property()
     {
-        var target = typeof(SerializationTests).GetProperty("MyProperty");
+        var target = typeof(SerializationTests).GetProperty("MyProperty")!;
         return Verify(target);
     }
 

src/Verify.Tests/SimpleTypeTests.cs

@@ -19,17 +19,9 @@ public Task Run(object arg)
     public Task StringWrappedInTask() =>
         Verify(Task.FromResult("theString"));
 
-    [Fact]
-    public Task NullWrappedInTask() =>
-        Verify(Task.FromResult<object?>(null));
-
     [Fact]
     public Task StringEmptyWrappedInTask() =>
-        Verify(Task.FromResult<object?>(string.Empty));
-
-    [Fact]
-    public Task Null() =>
-        Verify((string) null!);
+        Verify(Task.FromResult<object>(string.Empty));
 
     [Fact]
     public Task StringEmpty() =>

src/Verify.Tests/Tests.cs

@@ -387,18 +387,6 @@ public Task Streams() =>
                 })
             });
 
-    [Fact]
-    public Task StreamsWithNull() =>
-        Verify(
-            new List<Stream?>
-            {
-                new MemoryStream(new byte[]
-                {
-                    1
-                }),
-                null
-            });
-
     [Fact]
     public async Task ShouldNotIgnoreCase()
     {