Merge pull request #1 from OneBitSoftware/tgancheva/minor-code-fixes

Tgancheva/Minor code fixes

Author: SharePointRadi

src/OneBitSoftware.Utilities.OperationResult/Errors/OperationError.cs

@@ -4,12 +4,7 @@
 
 public class OperationError
 {
-    public OperationError(string message)
-    {
-        this.Message = message;
-    }
-
-    public OperationError(string message, int code)
+    public OperationError(string message, int? code = null)
     {
         this.Message = message;
         this.Code = code;

src/OneBitSoftware.Utilities.OperationResult/OperationResult.cs

@@ -97,28 +97,39 @@ public OperationResult AppendErrors(OperationResult otherOperationResult)
     /// This method will append an error with a specific `user-friendly` message to this operation result instance.
     /// </summary>
     /// <param name="message">A label consuming component defining the 'user-friendly' message.</param>
-    /// <param name="errorCode">The unique code of the error.</param>
+    /// <param name="code">The unique code of the error.</param>
     /// <param name="logLevel">The logging severity.</param>
+    /// <param name="details">A <see cref="string"/> with error details.</param>
     /// <returns>The current instance of the <see cref="OperationResult"/>.</returns>
-    public OperationResult AppendError(string message, int errorCode = 0, LogLevel? logLevel = null)
+    public OperationResult AppendError(string message, int? code = null, LogLevel? logLevel = null, string? details = null)
     {
-        if (message is null) throw new ArgumentNullException(nameof(message));
         if (string.IsNullOrWhiteSpace(message)) throw new ArgumentNullException(nameof(message));
 
-        var error = new OperationError(message, errorCode);
+        var error = new OperationError(message, code) { Details = details };
         this.AppendError(error, logLevel);
 
         return this;
     }
 
     /// <summary>
-    /// Appends an error message to the operation result instance.
+    /// Appends an <see cref="OperationError"/> to the internal errors collection.
     /// </summary>
-    /// <param name="message">The message that should be appended.</param>
-    /// <param name="errorCode">The unique code of the error.</param>
-    /// <param name="logLevel">The logging severity.</param>
+    /// <param name="error">An instance of <see cref="OperationError"/> 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 AppendErrorMessage(string message, int errorCode = 0, LogLevel? logLevel = null) => this.AppendError(message, errorCode, logLevel);
+    public OperationResult AppendError(OperationError error, LogLevel? logLevel = LogLevel.Error)
+    {
+        this.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 an exception to the error message collection and logs the full exception as an Error <see cref="LogEventLevel"/> level. A call to this method will set the Success property to false.
@@ -149,26 +160,6 @@ public OperationResult AppendException(Exception exception, int errorCode = 0, L
     // TODO: this method needs completing.
     private static LogLevel GetLogLevel(LogLevel? optionalLevel) => optionalLevel ?? LogLevel.Error;
 
-    /// <summary>
-    /// Appends an <see cref="OperationError"/> to the internal errors collection.
-    /// </summary>
-    /// <param name="error">An instance of <see cref="OperationError"/> 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 AppendError(OperationError error, LogLevel? logLevel = LogLevel.Error)
-    {
-        this.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 an <see cref="OperationError"/> to the internal errors collection.
     /// </summary>
@@ -229,12 +220,13 @@ public OperationResult(TResult resultObject) : base()
     /// This method will append an error with a specific `user-friendly` message to this operation result instance.
     /// </summary>
     /// <param name="message">A label consuming component defining the 'user-friendly' message.</param>
-    /// <param name="errorCode">The unique code of the error.</param>
+    /// <param name="code">The unique code of the error.</param>
     /// <param name="logLevel">The logging severity.</param>
+    /// <param name="details">A <see cref="string"/> with error details.</param>
     /// <returns>The current instance of the <see cref="OperationResult{TResult}"/>.</returns>
-    public new OperationResult<TResult> AppendError(string message, int errorCode = 0, LogLevel? logLevel = null)
+    public new OperationResult<TResult> AppendError(string message, int? code = null, LogLevel? logLevel = null, string? details = null)
     {
-        base.AppendError(message, errorCode, logLevel);
+        base.AppendError(message, code, logLevel, details);
 
         return this;
     }

src/OneBitSoftware.Utilities.OperationResult/OperationResultValidationExtensions.cs

@@ -51,7 +51,7 @@ public static void ValidateDefault<T, TValue>(this OperationResult<T> operationR
         if (value.Equals(default) == false) return;
 
         var errorMessage = $"{className}, {methodName} - The {propertyName} has a default value.";
-        operationResult.AppendErrorMessage(errorMessage, logLevel: level);
+        operationResult.AppendError(errorMessage, logLevel: level);
     }
 
     /// <summary>
@@ -70,7 +70,7 @@ public static void ValidateNullOrWhitespace<T>(this OperationResult<T> operation
         if (string.IsNullOrWhiteSpace(value) == false) return;
 
         var errorMessage = $"{className}, {methodName} - The {propertyName} is null, empty or consists only of whitespace characters.";
-        operationResult.AppendErrorMessage(errorMessage, logLevel: level);
+        operationResult.AppendError(errorMessage, logLevel: level);
     }
 
     /// <summary>
@@ -91,6 +91,6 @@ public static void ValidateNull<T>(this OperationResult<T> operationResult, obje
         if (value != null) return;
 
         var errorMessage = $"{className}, {methodName} - The {propertyName} is null.";
-        operationResult.AppendErrorMessage(errorMessage, logLevel: level);
+        operationResult.AppendError(errorMessage, logLevel: level);
     }
 }