Slight performance optimization by using ExceptionHelper to throw Arg…

…umentNullExceptions #21
Havunen · Jul 20, 2023 · 35a8df9 · 35a8df9
1 parent 043759d
commit 35a8df9
Show file tree

Hide file tree

Showing 16 changed files with 197 additions and 468 deletions.
diff --git a/SystemTextJsonPatch.Tests/IntegrationTests/NestedObjectIntegrationTest.cs b/SystemTextJsonPatch.Tests/IntegrationTests/NestedObjectIntegrationTest.cs
@@ -1,6 +1,7 @@
 using System;
 using System.Dynamic;
 using System.Text.Json;
+using SystemTextJsonPatch.Exceptions;
 using Xunit;
 
 namespace SystemTextJsonPatch.IntegrationTests;
@@ -338,7 +339,11 @@ public string StringProperty
 		{
 			get => _stringProperty;
 
-			set => _stringProperty = value ?? throw new ArgumentNullException(nameof(value));
+			set
+			{
+				ExceptionHelper.ThrowIfNull(value, nameof(value));
+				_stringProperty = value;
+			}
 		}
 	}
 

diff --git a/SystemTextJsonPatch.Tests/SystemTextJsonPatch.Tests.csproj b/SystemTextJsonPatch.Tests/SystemTextJsonPatch.Tests.csproj
@@ -5,7 +5,7 @@
     <IsPackable>false</IsPackable>
     <IsPublishable>false</IsPublishable>
     <IsUnitTestProject>True</IsUnitTestProject>
-    <LangVersion>10</LangVersion>
+    <LangVersion>11</LangVersion>
     <RepositoryUrl>https://github.com/Havunen/SystemTextJsonPatch.git</RepositoryUrl>
     <RepositoryType>git</RepositoryType>
     <AnalysisLevel>6.0-all</AnalysisLevel>

diff --git a/SystemTextJsonPatch/Adapters/AdapterFactory.cs b/SystemTextJsonPatch/Adapters/AdapterFactory.cs
@@ -1,7 +1,7 @@
-using System;
-using System.Collections;
+using System.Collections;
 using System.Text.Json;
 using System.Text.Json.Nodes;
+using SystemTextJsonPatch.Exceptions;
 using SystemTextJsonPatch.Internal;
 
 namespace SystemTextJsonPatch.Adapters;
@@ -18,10 +18,7 @@ public class AdapterFactory : IAdapterFactory
     public IAdapter Create(object target, JsonSerializerOptions options)
 #pragma warning restore PUB0001
     {
-        if (target == null)
-        {
-            throw new ArgumentNullException(nameof(target));
-        }
+        ExceptionHelper.ThrowIfNull(target, nameof(target));
 
         if (target is JsonObject)
         {

diff --git a/SystemTextJsonPatch/Adapters/ObjectAdapter.cs b/SystemTextJsonPatch/Adapters/ObjectAdapter.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Text.Json;
+using SystemTextJsonPatch.Exceptions;
 using SystemTextJsonPatch.Internal;
 using SystemTextJsonPatch.Operations;
 
@@ -31,9 +32,12 @@ public class ObjectAdapter : IObjectAdapterWithTest
        Action<JsonPatchError>? logErrorAction,
        IAdapterFactory adapterFactory)
     {
-        Options = options ?? throw new ArgumentNullException(nameof(options));
+	    ExceptionHelper.ThrowIfNull(options, nameof(options));
+	    ExceptionHelper.ThrowIfNull(adapterFactory, nameof(adapterFactory));
+
+		Options = options;
         LogErrorAction = logErrorAction;
-        AdapterFactory = adapterFactory ?? throw new ArgumentNullException(nameof(adapterFactory));
+        AdapterFactory = adapterFactory;
     }
 
     public JsonSerializerOptions Options { get; }
@@ -50,17 +54,10 @@ public class ObjectAdapter : IObjectAdapterWithTest
 
     public void Add(Operation? operation, object objectToApplyTo)
     {
-        if (operation == null)
-        {
-            throw new ArgumentNullException(nameof(operation));
-        }
-
-        if (objectToApplyTo == null)
-        {
-            throw new ArgumentNullException(nameof(objectToApplyTo));
-        }
+	    ExceptionHelper.ThrowIfNull(operation, nameof(operation));
+	    ExceptionHelper.ThrowIfNull(objectToApplyTo, nameof(objectToApplyTo));
 
-        Add(operation.Path, operation.Value, objectToApplyTo, operation);
+	    Add(operation.Path, operation.Value, objectToApplyTo, operation);
     }
 
     /// <summary>
@@ -74,20 +71,10 @@ public void Add(Operation? operation, object objectToApplyTo)
         Operation operation
     )
     {
-        if (path == null)
-        {
-            throw new ArgumentNullException(nameof(path));
-        }
-
-        if (objectToApplyTo == null)
-        {
-            throw new ArgumentNullException(nameof(objectToApplyTo));
-        }
+	    ExceptionHelper.ThrowIfNull(path, nameof(path));
+	    ExceptionHelper.ThrowIfNull(objectToApplyTo, nameof(objectToApplyTo));
+	    ExceptionHelper.ThrowIfNull(operation, nameof(operation));
 
-        if (operation == null)
-        {
-            throw new ArgumentNullException(nameof(operation));
-        }
 
         var parsedPath = new ParsedPath(path);
         var visitor = new ObjectVisitor(parsedPath, Options, AdapterFactory);
@@ -110,17 +97,10 @@ Operation operation
 
     public void Move(Operation operation, object objectToApplyTo)
     {
-        if (operation == null)
-        {
-            throw new ArgumentNullException(nameof(operation));
-        }
-
-        if (objectToApplyTo == null)
-        {
-            throw new ArgumentNullException(nameof(objectToApplyTo));
-        }
+	    ExceptionHelper.ThrowIfNull(objectToApplyTo, nameof(objectToApplyTo));
+	    ExceptionHelper.ThrowIfNull(operation, nameof(operation));
 
-        // Get value at 'from' location and add that value to the 'path' location
+	    // Get value at 'from' location and add that value to the 'path' location
         if (TryGetValue(operation.From, objectToApplyTo, operation, out var propertyValue))
         {
             // remove that value
@@ -136,17 +116,10 @@ public void Move(Operation operation, object objectToApplyTo)
 
     public void Remove(Operation operation, object objectToApplyTo)
     {
-        if (operation == null)
-        {
-            throw new ArgumentNullException(nameof(operation));
-        }
-
-        if (objectToApplyTo == null)
-        {
-            throw new ArgumentNullException(nameof(objectToApplyTo));
-        }
+	    ExceptionHelper.ThrowIfNull(operation, nameof(operation));
+		ExceptionHelper.ThrowIfNull(objectToApplyTo, nameof(objectToApplyTo));
 
-        Remove(operation.Path, objectToApplyTo, operation);
+	    Remove(operation.Path, objectToApplyTo, operation);
     }
 
     /// <summary>
@@ -179,17 +152,10 @@ private void Remove(string? path, object objectToApplyTo, Operation operationToR
 
     public void Replace(Operation operation, object objectToApplyTo)
     {
-        if (operation == null)
-        {
-            throw new ArgumentNullException(nameof(operation));
-        }
-
-        if (objectToApplyTo == null)
-        {
-            throw new ArgumentNullException(nameof(objectToApplyTo));
-        }
+	    ExceptionHelper.ThrowIfNull(operation, nameof(operation));
+	    ExceptionHelper.ThrowIfNull(objectToApplyTo, nameof(objectToApplyTo));
 
-        var parsedPath = new ParsedPath(operation.Path);
+		var parsedPath = new ParsedPath(operation.Path);
         var visitor = new ObjectVisitor(parsedPath, Options, AdapterFactory);
 
         var target = objectToApplyTo;
@@ -210,18 +176,11 @@ public void Replace(Operation operation, object objectToApplyTo)
 
     public void Copy(Operation operation, object objectToApplyTo)
     {
-        if (operation == null)
-        {
-            throw new ArgumentNullException(nameof(operation));
-        }
+	    ExceptionHelper.ThrowIfNull(operation, nameof(operation));
+	    ExceptionHelper.ThrowIfNull(objectToApplyTo, nameof(objectToApplyTo));
 
-        if (objectToApplyTo == null)
-        {
-            throw new ArgumentNullException(nameof(objectToApplyTo));
-        }
-
-        // Get value at 'from' location and add that value to the 'path' location
-        if (TryGetValue(operation.From, objectToApplyTo, operation, out var propertyValue))
+		// Get value at 'from' location and add that value to the 'path' location
+		if (TryGetValue(operation.From, objectToApplyTo, operation, out var propertyValue))
         {
             // Create deep copy
             if (ConversionResultProvider.TryCopyTo(propertyValue, propertyValue?.GetType(), this.Options, out object? convertedValue))
@@ -242,17 +201,10 @@ public void Copy(Operation operation, object objectToApplyTo)
 
     public void Test(Operation operation, object objectToApplyTo)
     {
-        if (operation == null)
-        {
-            throw new ArgumentNullException(nameof(operation));
-        }
+	    ExceptionHelper.ThrowIfNull(operation, nameof(operation));
+	    ExceptionHelper.ThrowIfNull(objectToApplyTo, nameof(objectToApplyTo));
 
-        if (objectToApplyTo == null)
-        {
-            throw new ArgumentNullException(nameof(objectToApplyTo));
-        }
-
-        var parsedPath = new ParsedPath(operation.Path);
+		var parsedPath = new ParsedPath(operation.Path);
         var visitor = new ObjectVisitor(parsedPath, Options, AdapterFactory);
 
         var target = objectToApplyTo;
@@ -277,20 +229,9 @@ public void Test(Operation operation, object objectToApplyTo)
         Operation operation,
         out object? propertyValue)
     {
-        if (fromLocation == null)
-        {
-            throw new ArgumentNullException(nameof(fromLocation));
-        }
-
-        if (objectToGetValueFrom == null)
-        {
-            throw new ArgumentNullException(nameof(objectToGetValueFrom));
-        }
-
-        if (operation == null)
-        {
-            throw new ArgumentNullException(nameof(operation));
-        }
+	    ExceptionHelper.ThrowIfNull(fromLocation, nameof(fromLocation));
+		ExceptionHelper.ThrowIfNull(operation, nameof(operation));
+        ExceptionHelper.ThrowIfNull(objectToGetValueFrom, nameof(objectToGetValueFrom));
 
         propertyValue = null;
 

diff --git a/SystemTextJsonPatch/Exceptions/ExceptionHelper.cs b/SystemTextJsonPatch/Exceptions/ExceptionHelper.cs
@@ -0,0 +1,19 @@
+using System;
+
+namespace SystemTextJsonPatch.Exceptions
+{
+	internal class ExceptionHelper
+	{
+		public static void ThrowIfNull(object? argument, string paramName)
+		{
+#if NETSTANDARD2_0
+			if (argument == null)
+			{
+				throw new ArgumentNullException(nameof(argument));
+			}
+#else
+			ArgumentNullException.ThrowIfNull(argument, paramName);
+#endif
+		}
+	}
+}
diff --git a/SystemTextJsonPatch/Helpers/JsonPatchProperty.cs b/SystemTextJsonPatch/Helpers/JsonPatchProperty.cs
diff --git a/SystemTextJsonPatch/Internal/ListAdapter.cs b/SystemTextJsonPatch/Internal/ListAdapter.cs
@@ -2,6 +2,7 @@
 using System.Collections;
 using System.Collections.Generic;
 using System.Text.Json;
+using SystemTextJsonPatch.Exceptions;
 
 namespace SystemTextJsonPatch.Internal;
 
@@ -270,17 +271,10 @@ private static bool TryGetListTypeArgument(IList list, out Type? listTypeArgumen
 
     private static Type? ExtractGenericInterface(Type queryType, Type interfaceType)
     {
-        if (queryType == null)
-        {
-            throw new ArgumentNullException(nameof(queryType));
-        }
-
-        if (interfaceType == null)
-        {
-            throw new ArgumentNullException(nameof(interfaceType));
-        }
+	    ExceptionHelper.ThrowIfNull(queryType, nameof(queryType));
+	    ExceptionHelper.ThrowIfNull(interfaceType, nameof(interfaceType));
 
-        if (IsGenericInstantiation(queryType, interfaceType))
+		if (IsGenericInstantiation(queryType, interfaceType))
         {
             // queryType matches (i.e. is a closed generic type created from) the open generic type.
             return queryType;

diff --git a/SystemTextJsonPatch/Internal/ObjectVisitor.cs b/SystemTextJsonPatch/Internal/ObjectVisitor.cs
@@ -1,6 +1,6 @@
-using System;
-using System.Text.Json;
+using System.Text.Json;
 using SystemTextJsonPatch.Adapters;
+using SystemTextJsonPatch.Exceptions;
 
 namespace SystemTextJsonPatch.Internal;
 
@@ -21,9 +21,12 @@ public ObjectVisitor(ParsedPath path, JsonSerializerOptions options)
 
     public ObjectVisitor(ParsedPath path, JsonSerializerOptions options, IAdapterFactory adapterFactory)
     {
-        _path = path;
-        _options = options ?? throw new ArgumentNullException(nameof(options));
-        _adapterFactory = adapterFactory ?? throw new ArgumentNullException(nameof(adapterFactory));
+	    ExceptionHelper.ThrowIfNull(options, nameof(options));
+	    ExceptionHelper.ThrowIfNull(adapterFactory, nameof(adapterFactory));
+
+		_path = path;
+        _options = options;
+        _adapterFactory = adapterFactory;
     }
 
     public bool TryVisit(ref object target, out IAdapter? adapter, out string? errorMessage)

diff --git a/SystemTextJsonPatch/Internal/ParsedPath.cs b/SystemTextJsonPatch/Internal/ParsedPath.cs
@@ -16,12 +16,9 @@ namespace SystemTextJsonPatch.Internal;
 
     public ParsedPath(string? path)
     {
-        if (path == null)
-        {
-            throw new ArgumentNullException(nameof(path));
-        }
+	    ExceptionHelper.ThrowIfNull(path, nameof(path));
 
-        _segments = ParsePath(path);
+	    _segments = ParsePath(path!);
     }
 
     public string? LastSegment