Merge pull request #23 from I-RzR-I/feature/SmallCodeAdjustments

Adjust some methods location and new exec function

Author: I-RzR-I

.gitignore

@@ -267,4 +267,6 @@ wwwroot/lib/
 
 # Coverlet
 Report/
-coverage.*
+coverage.*
+
+*.ncrunchsolution

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2022-2023 RzR
+Copyright (c) 2022-2024 RzR
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -11,9 +11,9 @@ As a result, you can have control over the messages and types of messages that w
 By currently following, 6 general types of messages (`Info`, `Warning`, `Error`, `NotFound`, `AccessDenied`, `Exception`) are implemented that can be returned to the caller.
 As you can see in the `MessageType` enum, there are 9 types of messages, for all 3 (`Info`, `Warning`, `Error`) types previously specified exists with new ends `Confirm`. The idea of all of them is to inform UI (or caller) that returned message will be parsed/used as a dialog box/popup/modal.
 
-For more flexible and intuitive use, in solution persist extension method like fluent access to set message, error, etc (`WithMessage`, `WithKeyCode`, `WithCodeMessage`, `WithError`, `WithErrors`).
+For more flexible and intuitive use, in solution persist extension method like fluent access to set message, error, etc (`WithMessage`, `WithKeyCode`, `WithCodeMessage`, `WithError`, `WithErrors`). In some cases when you may have the necessity to add in the result additional information like the link between the code execution method and data store name: stored procedure, function or table, etc; in code/result is defined object `RelatedObject` where this information can be stored and returned to the caller.
 
-For more efficiently using, when in some cases when you may need to execute some custom actions after a successful or failed execution request. In that case was added extension methods (`ActionOnSuccess`, `ActionOnFailure`, `ActionOn`, `ExecuteAction`) which allow you to execute this action like insert log when execution has a status equal to failure.
+For more efficiently using, when in some cases when you may need to execute some custom actions/functions after a successful or failed execution request. In that case was added extension methods (`ActionOnSuccess`, `ActionOnFailure`, `ActionOn`, `ExecuteAction`, `FunctionOnSuccess`, `FunctionOnFailure`, `FunctionOn`, `ExecuteFunction`) which allow you to execute this action/function like insert log when execution has a status equal to failure.
 
 No additional components or packs are required for use. So, it only needs to be added/installed in the project and can be used instantly.
 

docs/CHANGELOG.md

@@ -58,3 +58,8 @@
 -> Add `RelatedObject` in code (means related object in code execution, usually used in case of some errors to show method name, stored procedure, table, etc).<br />
 -> Adjust code to solution code style.<br />
 -> Adjust exposed methods and add a few new.
+
+
+### **v1.3.3.6068** 
+-> Adjust the location for methods: `GetFirstMessage`, `GetFirstMessageWithDetails`.<br />
+-> Add a new extension for result execution `FunctionExtensions` (`FunctionOnSuccess`, `FunctionOnFailure`, `FunctionOn`, `ExecuteFunction`), which allows to execute of one or more functions.<br />

docs/usage.md

@@ -195,4 +195,28 @@ public IResult<Foo> GetFoo(int recordId)
         return result;
     }
 ```
-The same situation and implementation can be used for `ActionOn`, `ExecuteAction` with specifying necessary action/s.
+The same situation and implementation can be used for `ActionOn`, `ExecuteAction` with specifying necessary action/s.
+
+An example how to user `RelatedObject` in result:
+```csharp
+public async Task<Result> AddFooAsync(Foo request, CancellationToken cancellationToken
+         = default)
+        {
+            try
+            {
+                await _ctx.Foos.AddAsync(request, cancellationToken);
+                await _ctx.SaveChangesAsync(cancellationToken);
+                
+                //return success message with data
+                return true;
+            }
+            catch (Exception e)
+            {
+                _logger.LogError(e, "Internal error on add foo");
+
+                return Result.
+                .Failure("Internal error on add new foo", relatedObjects: new RelatedObjectModel(nameof(AddFooAsync), "Foos"))
+                .AddError(e);
+            }
+        }
+```

src/AggregatedGenericResultMessage/Abstractions/IResult.cs

@@ -19,6 +19,7 @@
 using System.Collections.Generic;
 using System.Xml.Serialization;
 using AggregatedGenericResultMessage.Abstractions.Models;
+using AggregatedGenericResultMessage.Models;
 
 #endregion
 
@@ -56,5 +57,19 @@ public interface IResult
         /// <returns></returns>
         /// <remarks></remarks>
         SoapResult ToSoapResult();
+
+        /// <summary>
+        ///     Get first message from response
+        /// </summary>
+        /// <returns></returns>
+        /// <remarks></remarks>
+        string GetFirstMessage();
+        
+        /// <summary>
+        ///     Get first message from response
+        /// </summary>
+        /// <returns></returns>
+        /// <remarks></remarks>
+        MessageDataModel GetFirstMessageWithDetails();
     }
 }

src/AggregatedGenericResultMessage/Abstractions/IResultOfT.cs

@@ -17,7 +17,6 @@
 #region U S A G E S
 
 using System.Xml.Serialization;
-using AggregatedGenericResultMessage.Models;
 
 #endregion
 
@@ -31,19 +30,5 @@ public interface IResult<T> : IResult
         ///     The result of the response, if there is no errors.
         /// </summary>
         T Response { get; set; }
-        
-        /// <summary>
-        ///     Get first message from response
-        /// </summary>
-        /// <returns></returns>
-        /// <remarks></remarks>
-        string GetFirstMessage();
-
-        /// <summary>
-        ///     Get first message from response
-        /// </summary>
-        /// <returns></returns>
-        /// <remarks></remarks>
-        MessageDataModel GetFirstMessageWithDetails();
     }
 }

src/AggregatedGenericResultMessage/AggregatedGenericResultMessage.csproj

@@ -58,6 +58,10 @@
     </None>
     <None Include="..\.editorconfig" />
   </ItemGroup>
+
+  <ItemGroup>
+    <Folder Include="Extensions\Result\Functions\" />
+  </ItemGroup>
   <ProjectExtensions>
     <VisualStudio>
       <UserProperties BuildVersion_StartDate="2022/7/1" />

src/AggregatedGenericResultMessage/Extensions/Common/BoolExtensions.cs

@@ -0,0 +1,51 @@
+// ***********************************************************************
+//  Assembly         : RzR.Shared.ResultMessage.AggregatedGenericResultMessage
+//  Author           : RzR
+//  Created On       : 2024-01-31 22:55
+// 
+//  Last Modified By : RzR
+//  Last Modified On : 2024-01-31 22:58
+// ***********************************************************************
+//  <copyright file="BoolExtensions.cs" company="">
+//   Copyright (c) RzR. All rights reserved.
+//  </copyright>
+// 
+//  <summary>
+//  </summary>
+// ***********************************************************************
+
+#region U S A G E S
+
+using CodeSource;
+
+#endregion
+
+namespace AggregatedGenericResultMessage.Extensions.Common
+{
+    /// -------------------------------------------------------------------------------------------------
+    /// <summary>An extensions.</summary>
+    /// <remarks>31-Jan-24.</remarks>
+    /// =================================================================================================
+    internal static class BoolExtensions
+    {
+        /// -------------------------------------------------------------------------------------------------
+        /// <summary>Check if source value is equals with true.</summary>
+        /// <remarks></remarks>
+        /// <param name="source">Source object to be checked.</param>
+        /// <returns>True if true, false if not.</returns>
+        /// =================================================================================================
+        [CodeSource("https://github.com/I-RzR-I/DomainCommonExtensions", "RzR", 1D)]
+        internal static bool IsTrue(this bool source)
+            => source.IsNotNull() && source.Equals(true);
+
+        /// -------------------------------------------------------------------------------------------------
+        /// <summary>Check if source value is equals with false.</summary>
+        /// <remarks></remarks>
+        /// <param name="source">Source object to be checked.</param>
+        /// <returns>True if false, false if not.</returns>
+        /// =================================================================================================
+        [CodeSource("https://github.com/I-RzR-I/DomainCommonExtensions", "RzR", 1D)]
+        internal static bool IsFalse(this bool source)
+            => source.IsNull() || source.Equals(false);
+    }
+}

src/AggregatedGenericResultMessage/Extensions/Result/Actions/ActionExtensions.cs

@@ -75,8 +75,8 @@ public static TResult ActionOnFailure<TResult>(this TResult result, params Actio
         /// <param name="onFailure">Action on failure</param>
         /// <typeparam name="TResult">Type of result</typeparam>
         /// <remarks></remarks>
-        public static TResult ActionOn<TResult>(this TResult result, Action<TResult> onSuccess, Action<TResult> onFailure)
-            where TResult : IResult
+        public static TResult ActionOn<TResult>(this TResult result, Action<TResult> onSuccess, 
+            Action<TResult> onFailure) where TResult : IResult
         {
             if (!result.IsSuccess)
             {
@@ -102,8 +102,8 @@ public static TResult ActionOn<TResult>(this TResult result, Action<TResult> onS
         /// <param name="onFailure">Action on failure</param>
         /// <typeparam name="TResult">Type of result</typeparam>
         /// <remarks></remarks>
-        public static TResult ActionOn<TResult>(this TResult result, Action<TResult> onSuccess, IEnumerable<Action<TResult>> onFailure)
-            where TResult : IResult
+        public static TResult ActionOn<TResult>(this TResult result, Action<TResult> onSuccess, 
+            IEnumerable<Action<TResult>> onFailure) where TResult : IResult
         {
             if (!result.IsSuccess)
             {
@@ -130,8 +130,8 @@ public static TResult ActionOn<TResult>(this TResult result, Action<TResult> onS
         /// <param name="onFailure">Action on failure</param>
         /// <typeparam name="TResult">Type of result</typeparam>
         /// <remarks></remarks>
-        public static TResult ActionOn<TResult>(this TResult result, IEnumerable<Action<TResult>> onSuccess, Action<TResult> onFailure)
-            where TResult : IResult
+        public static TResult ActionOn<TResult>(this TResult result, IEnumerable<Action<TResult>> onSuccess,
+            Action<TResult> onFailure) where TResult : IResult
         {
             if (!result.IsSuccess)
             {
@@ -158,8 +158,8 @@ public static TResult ActionOn<TResult>(this TResult result, IEnumerable<Action<
         /// <param name="onFailure">Action on failure</param>
         /// <typeparam name="TResult">Type of result</typeparam>
         /// <remarks></remarks>
-        public static TResult ActionOn<TResult>(this TResult result, IEnumerable<Action<TResult>> onSuccess, IEnumerable<Action<TResult>> onFailure)
-            where TResult : IResult
+        public static TResult ActionOn<TResult>(this TResult result, IEnumerable<Action<TResult>> onSuccess,
+            IEnumerable<Action<TResult>> onFailure) where TResult : IResult
         {
             if (!result.IsSuccess)
             {