Additions for 1.8

Author: SharePointRadi

src/OneBitSoftware.Utilities.OperationResult/OneBitSoftware.Utilities.OperationResult.csproj

@@ -32,7 +32,7 @@
     <PackageRequireLicenseAcceptance>False</PackageRequireLicenseAcceptance>
     <PackageReadmeFile>README.md</PackageReadmeFile>
     <PackageTags>OneBitSoftware; OperationResult;</PackageTags>
-    <Version>1.1.7</Version>
+    <Version>1.1.8</Version>
   </PropertyGroup>
 
 </Project>

src/OneBitSoftware.Utilities.OperationResult/OperationResult.cs

@@ -15,7 +15,7 @@ public class OperationResult
     private readonly List<IOperationError> _errors = new();
     private readonly List<string> _successMessages = new();
 
-    private readonly ILogger? _logger;
+    protected readonly ILogger? _logger;
 
     /// <summary>
     /// Gets or sets a value indicating whether the operation is successful or not.
@@ -208,13 +208,13 @@ public static OperationResult FromError(string message, int? code = null, LogLev
     }
 
     // TODO: this method needs completing.
-    private static LogLevel GetLogLevel(LogLevel? optionalLevel) => optionalLevel ?? LogLevel.Error;
+    protected static LogLevel GetLogLevel(LogLevel? optionalLevel) => optionalLevel ?? LogLevel.Error;
 
     /// <summary>
     /// Appends an <see cref="IOperationError"/> to the internal errors collection.
     /// </summary>
     /// <param name="error">An instance of <see cref="IOperationError"/> to add to the internal errors collection.</param>
-    private void AppendErrorInternal(IOperationError error) => this._errors.Add(error);
+    protected void AppendErrorInternal(IOperationError error) => this._errors.Add(error);
 }
 
 /// <summary>
@@ -234,19 +234,19 @@ public OperationResult()
     /// <summary>
     /// Initializes a new instance of the <see cref="OperationResult"/> class.
     /// </summary>
-    /// <param name="loggerService">An instance of <see cref="ILoggerService"/>.</param>
+    /// <param name="logger">An instance of <see cref="ILoggerService"/>.</param>
     /// <remarks>If the operation is a get operation, an empty result must return a truthy Success value.</remarks>
-    public OperationResult(ILogger loggerService) : base(loggerService)
+    public OperationResult(ILogger logger) : base(logger)
     {
     }
 
     /// <summary>
     /// Initializes a new instance of the <see cref="OperationResult"/> class and sets the passed result object. Internally, this will set the Success result to True.
     /// </summary>
     /// <param name="resultObject">An initial failure message for the operation result. This will fail the success status.</param>
-    /// <param name="loggerService">An instance of <see cref="ILoggerService"/>.</param>
+    /// <param name="logger">An instance of <see cref="ILogger"/>.</param>
     /// <remarks>If the operation is a get operation, an empty result must return a truthy Success value.</remarks>
-    public OperationResult(TResult resultObject, ILogger loggerService) : base(loggerService)
+    public OperationResult(TResult resultObject, ILogger logger) : base(logger)
     {
         this.ResultObject = resultObject;
     }
@@ -281,6 +281,26 @@ public OperationResult(TResult resultObject) : base()
         return this;
     }
 
+    /// <summary>
+    /// Appends an <see cref="IOperationError"/> to the internal errors collection.
+    /// </summary>
+    /// <param name="error">An instance of <see cref="IOperationError"/> to add to the internal errors collection.</param>
+    /// <param name="logLevel">The logging level.</param>
+    /// <returns>The current instance of the <see cref="OperationResult"/>.</returns>
+    public OperationResult<TResult> AppendError(IOperationError error, LogLevel? logLevel = LogLevel.Error)
+    {
+        base.AppendErrorInternal(error);
+
+        if (this._logger is not null)
+        {
+#pragma warning disable CA2254 // Template should be a static expression
+            this._logger.Log(GetLogLevel(logLevel), error.Message);
+#pragma warning restore CA2254 // Template should be a static expression
+        }
+
+        return this;
+    }
+
     /// <summary>
     /// Appends error messages from <paramref name="otherOperationResult"/> to <paramref name="originalOperationResult"/>.
     /// </summary>