| | | 1 | | namespace AsiBackbone.Core.Results; |
| | | 2 | | |
| | | 3 | | /// <summary> |
| | | 4 | | /// Represents the outcome of an ASI Backbone operation. |
| | | 5 | | /// </summary> |
| | | 6 | | public sealed class BackboneResult |
| | | 7 | | { |
| | | 8 | | private const string DefaultFailureMessage = "Operation failed."; |
| | | 9 | | |
| | 2 | 10 | | private static readonly string[] EmptyMessages = []; |
| | | 11 | | |
| | 26 | 12 | | private BackboneResult(bool succeeded, IReadOnlyList<string> messages) |
| | | 13 | | { |
| | 26 | 14 | | Succeeded = succeeded; |
| | 26 | 15 | | Messages = messages; |
| | 26 | 16 | | } |
| | | 17 | | |
| | | 18 | | /// <summary> |
| | | 19 | | /// Gets a value indicating whether the operation succeeded. |
| | | 20 | | /// </summary> |
| | 46 | 21 | | public bool Succeeded { get; } |
| | | 22 | | |
| | | 23 | | /// <summary> |
| | | 24 | | /// Gets a value indicating whether the operation failed. |
| | | 25 | | /// </summary> |
| | 20 | 26 | | public bool Failed => !Succeeded; |
| | | 27 | | |
| | | 28 | | /// <summary> |
| | | 29 | | /// Gets the messages associated with the operation result. |
| | | 30 | | /// </summary> |
| | 40 | 31 | | public IReadOnlyList<string> Messages { get; } |
| | | 32 | | |
| | | 33 | | /// <summary> |
| | | 34 | | /// Creates a successful result with no messages. |
| | | 35 | | /// </summary> |
| | | 36 | | /// <returns>A successful operation result.</returns> |
| | | 37 | | public static BackboneResult Success() |
| | | 38 | | { |
| | 2 | 39 | | return new BackboneResult(true, EmptyMessages); |
| | | 40 | | } |
| | | 41 | | |
| | | 42 | | /// <summary> |
| | | 43 | | /// Creates a successful result with one message. |
| | | 44 | | /// </summary> |
| | | 45 | | /// <param name="message">The message associated with the successful result.</param> |
| | | 46 | | /// <returns>A successful operation result.</returns> |
| | | 47 | | public static BackboneResult Success(string message) |
| | | 48 | | { |
| | 4 | 49 | | return new BackboneResult(true, NormalizeMessages([message])); |
| | | 50 | | } |
| | | 51 | | |
| | | 52 | | /// <summary> |
| | | 53 | | /// Creates a successful result with one or more messages. |
| | | 54 | | /// </summary> |
| | | 55 | | /// <param name="messages">The messages associated with the successful result.</param> |
| | | 56 | | /// <returns>A successful operation result.</returns> |
| | | 57 | | public static BackboneResult Success(IEnumerable<string> messages) |
| | | 58 | | { |
| | 8 | 59 | | return new BackboneResult(true, NormalizeMessages(messages)); |
| | | 60 | | } |
| | | 61 | | |
| | | 62 | | /// <summary> |
| | | 63 | | /// Creates a failed result with one message. |
| | | 64 | | /// </summary> |
| | | 65 | | /// <param name="message">The message associated with the failed result.</param> |
| | | 66 | | /// <returns>A failed operation result.</returns> |
| | | 67 | | public static BackboneResult Failure(string message) |
| | | 68 | | { |
| | 4 | 69 | | return new BackboneResult(false, NormalizeMessages([message], DefaultFailureMessage)); |
| | | 70 | | } |
| | | 71 | | |
| | | 72 | | /// <summary> |
| | | 73 | | /// Creates a failed result with one or more messages. |
| | | 74 | | /// </summary> |
| | | 75 | | /// <param name="messages">The messages associated with the failed result.</param> |
| | | 76 | | /// <returns>A failed operation result.</returns> |
| | | 77 | | public static BackboneResult Failure(IEnumerable<string> messages) |
| | | 78 | | { |
| | 8 | 79 | | return new BackboneResult(false, NormalizeMessages(messages, DefaultFailureMessage)); |
| | | 80 | | } |
| | | 81 | | |
| | | 82 | | private static IReadOnlyList<string> NormalizeMessages( |
| | | 83 | | IEnumerable<string>? messages, |
| | | 84 | | string? fallbackMessage = null) |
| | | 85 | | { |
| | 24 | 86 | | string[] normalizedMessages = messages? |
| | 34 | 87 | | .Where(message => !string.IsNullOrWhiteSpace(message)) |
| | 16 | 88 | | .Select(message => message.Trim()) |
| | 24 | 89 | | .ToArray() ?? []; |
| | | 90 | | |
| | 24 | 91 | | return normalizedMessages.Length == 0 |
| | 24 | 92 | | ? fallbackMessage is null |
| | 24 | 93 | | ? EmptyMessages |
| | 24 | 94 | | : Array.AsReadOnly([fallbackMessage]) |
| | 24 | 95 | | : Array.AsReadOnly(normalizedMessages); |
| | | 96 | | } |
| | | 97 | | } |