Use Result.Success property instead of Result.FromSuccess() (#283)

Signed-off-by: Octol1ttle <[email protected]>
TeamOctolings · Mar 21, 2024 · a80debf · a80debf
1 parent 309d900
commit a80debf
Show file tree

Hide file tree

Showing 18 changed files with 59 additions and 54 deletions.
diff --git a/src/Commands/Events/ErrorLoggingPostExecutionEvent.cs b/src/Commands/Events/ErrorLoggingPostExecutionEvent.cs
@@ -20,8 +20,8 @@ namespace Octobot.Commands.Events;
 [UsedImplicitly]
 public class ErrorLoggingPostExecutionEvent : IPostExecutionEvent
 {
-    private readonly ILogger<ErrorLoggingPostExecutionEvent> _logger;
     private readonly IFeedbackService _feedback;
+    private readonly ILogger<ErrorLoggingPostExecutionEvent> _logger;
     private readonly IDiscordRestUserAPI _userApi;
 
     public ErrorLoggingPostExecutionEvent(ILogger<ErrorLoggingPostExecutionEvent> logger, IFeedbackService feedback,
@@ -53,7 +53,7 @@ public async Task<Result> AfterExecutionAsync(
 
         if (result.IsSuccess)
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var botResult = await _userApi.GetCurrentUserAsync(ct);

diff --git a/src/Commands/Events/LoggingPreparationErrorEvent.cs b/src/Commands/Events/LoggingPreparationErrorEvent.cs
@@ -33,6 +33,6 @@ public Task<Result> PreparationFailed(
     {
         _logger.LogResult(preparationResult, "Error in slash command preparation.");
 
-        return Task.FromResult(Result.FromSuccess());
+        return Task.FromResult(Result.Success);
     }
 }
diff --git a/src/Commands/MuteCommandGroup.cs b/src/Commands/MuteCommandGroup.cs
@@ -118,7 +118,8 @@ public async Task<Result> ExecuteMute(
             return await _feedback.SendContextualEmbedResultAsync(failedEmbed, ct: CancellationToken);
         }
 
-        return await MuteUserAsync(executor, target, reason, duration, guildId, data, channelId, bot, CancellationToken);
+        return await MuteUserAsync(executor, target, reason, duration, guildId, data, channelId, bot,
+            CancellationToken);
     }
 
     private async Task<Result> MuteUserAsync(
@@ -143,14 +144,16 @@ var interactionResult
 
         var until = DateTimeOffset.UtcNow.Add(duration); // >:)
 
-        var muteMethodResult = await SelectMuteMethodAsync(executor, target, reason, duration, guildId, data, bot, until, ct);
+        var muteMethodResult =
+            await SelectMuteMethodAsync(executor, target, reason, duration, guildId, data, bot, until, ct);
         if (!muteMethodResult.IsSuccess)
         {
             return ResultExtensions.FromError(muteMethodResult);
         }
 
         var title = string.Format(Messages.UserMuted, target.GetTag());
-        var description = new StringBuilder().AppendBulletPointLine(string.Format(Messages.DescriptionActionReason, reason))
+        var description = new StringBuilder()
+            .AppendBulletPointLine(string.Format(Messages.DescriptionActionReason, reason))
             .AppendBulletPoint(string.Format(
                 Messages.DescriptionActionExpiresAt, Markdown.Timestamp(until))).ToString();
 
@@ -348,11 +351,12 @@ var interactionResult
     }
 
     private async Task<Result> RemoveMuteRoleAsync(
-        IUser executor, IUser target, string reason, Snowflake guildId, MemberData memberData, CancellationToken ct = default)
+        IUser executor, IUser target, string reason, Snowflake guildId, MemberData memberData,
+        CancellationToken ct = default)
     {
         if (memberData.MutedUntil is null)
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var unmuteResult = await _guildApi.ModifyGuildMemberAsync(
@@ -372,7 +376,7 @@ private async Task<Result> RemoveTimeoutAsync(
     {
         if (communicationDisabledUntil is null)
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var unmuteResult = await _guildApi.ModifyGuildMemberAsync(

diff --git a/src/Data/Options/BoolOption.cs b/src/Data/Options/BoolOption.cs
@@ -20,7 +20,7 @@ public override Result Set(JsonNode settings, string from)
         }
 
         settings[Name] = value;
-        return Result.FromSuccess();
+        return Result.Success;
     }
 
     private static bool TryParseBool(string from, out bool value)

diff --git a/src/Data/Options/Option.cs b/src/Data/Options/Option.cs
@@ -35,7 +35,13 @@ public virtual string Display(JsonNode settings)
     public virtual Result Set(JsonNode settings, string from)
     {
         settings[Name] = from;
-        return Result.FromSuccess();
+        return Result.Success;
+    }
+
+    public Result Reset(JsonNode settings)
+    {
+        settings[Name] = null;
+        return Result.Success;
     }
 
     /// <summary>
@@ -48,10 +54,4 @@ public virtual T Get(JsonNode settings)
         var property = settings[Name];
         return property != null ? property.GetValue<T>() : DefaultValue;
     }
-
-    public Result Reset(JsonNode settings)
-    {
-        settings[Name] = null;
-        return Result.FromSuccess();
-    }
 }
diff --git a/src/Data/Options/SnowflakeOption.cs b/src/Data/Options/SnowflakeOption.cs
@@ -32,7 +32,7 @@ public override Result Set(JsonNode settings, string from)
         }
 
         settings[Name] = parsed;
-        return Result.FromSuccess();
+        return Result.Success;
     }
 
     [GeneratedRegex("[^0-9]")]

diff --git a/src/Data/Options/TimeSpanOption.cs b/src/Data/Options/TimeSpanOption.cs
@@ -22,6 +22,6 @@ public override Result Set(JsonNode settings, string from)
         }
 
         settings[Name] = span.ToString();
-        return Result.FromSuccess();
+        return Result.Success;
     }
 }
diff --git a/src/Extensions/CollectionExtensions.cs b/src/Extensions/CollectionExtensions.cs
@@ -32,7 +32,7 @@ public static Result AggregateErrors(this List<Result> list)
     {
         return list.Count switch
         {
-            0 => Result.FromSuccess(),
+            0 => Result.Success,
             1 => list[0],
             _ => new AggregateError(list.Cast<IResult>().ToArray())
         };

diff --git a/src/Extensions/GuildScheduledEventExtensions.cs b/src/Extensions/GuildScheduledEventExtensions.cs
@@ -22,7 +22,7 @@ public static Result TryGetExternalEventData(this IGuildScheduledEvent scheduled
         }
 
         return scheduledEvent.ScheduledEndTime.AsOptional().IsDefined(out endTime)
-            ? Result.FromSuccess()
+            ? Result.Success
             : new ArgumentNullError(nameof(scheduledEvent.ScheduledEndTime));
     }
 }
diff --git a/src/Responders/GuildLoadedResponder.cs b/src/Responders/GuildLoadedResponder.cs
@@ -42,7 +42,7 @@ public async Task<Result> RespondAsync(IGuildCreate gatewayEvent, CancellationTo
     {
         if (!gatewayEvent.Guild.IsT0) // Guild is not IAvailableGuild
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var guild = gatewayEvent.Guild.AsT0;
@@ -76,12 +76,12 @@ public async Task<Result> RespondAsync(IGuildCreate gatewayEvent, CancellationTo
 
         if (!GuildSettings.ReceiveStartupMessages.Get(cfg))
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         if (GuildSettings.PrivateFeedbackChannel.Get(cfg).Empty())
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         Messages.Culture = GuildSettings.Language.Get(cfg);

diff --git a/src/Responders/GuildMemberJoinedResponder.cs b/src/Responders/GuildMemberJoinedResponder.cs
@@ -54,7 +54,7 @@ public async Task<Result> RespondAsync(IGuildMemberAdd gatewayEvent, Cancellatio
         if (GuildSettings.WelcomeMessagesChannel.Get(cfg).Empty()
             || GuildSettings.WelcomeMessage.Get(cfg) is "off" or "disable" or "disabled")
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         Messages.Culture = GuildSettings.Language.Get(cfg);
@@ -85,7 +85,7 @@ private async Task<Result> TryReturnRolesAsync(
     {
         if (!GuildSettings.ReturnRolesOnRejoin.Get(cfg))
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var assignRoles = new List<Snowflake>();

diff --git a/src/Responders/GuildMemberLeftResponder.cs b/src/Responders/GuildMemberLeftResponder.cs
@@ -38,13 +38,13 @@ public async Task<Result> RespondAsync(IGuildMemberRemove gatewayEvent, Cancella
         var memberData = data.GetOrCreateMemberData(user.ID);
         if (memberData.BannedUntil is not null || memberData.Kicked)
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         if (GuildSettings.WelcomeMessagesChannel.Get(cfg).Empty()
             || GuildSettings.LeaveMessage.Get(cfg) is "off" or "disable" or "disabled")
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         Messages.Culture = GuildSettings.Language.Get(cfg);

diff --git a/src/Responders/GuildUnloadedResponder.cs b/src/Responders/GuildUnloadedResponder.cs
@@ -33,6 +33,6 @@ public Task<Result> RespondAsync(IGuildDelete gatewayEvent, CancellationToken ct
             _logger.LogInformation("Unloaded guild {GuildId}", guildId);
         }
 
-        return Task.FromResult(Result.FromSuccess());
+        return Task.FromResult(Result.Success);
     }
 }
diff --git a/src/Responders/MessageDeletedResponder.cs b/src/Responders/MessageDeletedResponder.cs
@@ -39,13 +39,13 @@ public async Task<Result> RespondAsync(IMessageDelete gatewayEvent, Cancellation
     {
         if (!gatewayEvent.GuildID.IsDefined(out var guildId))
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var cfg = await _guildData.GetSettings(guildId, ct);
         if (GuildSettings.PrivateFeedbackChannel.Get(cfg).Empty())
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var messageResult = await _channelApi.GetChannelMessageAsync(gatewayEvent.ChannelID, gatewayEvent.ID, ct);
@@ -56,7 +56,7 @@ public async Task<Result> RespondAsync(IMessageDelete gatewayEvent, Cancellation
 
         if (string.IsNullOrWhiteSpace(message.Content))
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var auditLogResult = await _auditLogApi.GetGuildAuditLogAsync(

diff --git a/src/Responders/MessageEditedResponder.cs b/src/Responders/MessageEditedResponder.cs
@@ -48,28 +48,28 @@ public async Task<Result> RespondAsync(IMessageUpdate gatewayEvent, Cancellation
 
         if (!gatewayEvent.GuildID.IsDefined(out var guildId))
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         if (gatewayEvent.Author.IsDefined(out var author) && author.IsBot.OrDefault(false))
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         if (!gatewayEvent.EditedTimestamp.IsDefined(out var timestamp))
         {
-            return Result.FromSuccess(); // The message wasn't actually edited
+            return Result.Success; // The message wasn't actually edited
         }
 
         if (!gatewayEvent.Content.IsDefined(out var newContent))
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var cfg = await _guildData.GetSettings(guildId, ct);
         if (GuildSettings.PrivateFeedbackChannel.Get(cfg).Empty())
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var cacheKey = new KeyHelpers.MessageCacheKey(channelId, messageId);
@@ -78,12 +78,12 @@ public async Task<Result> RespondAsync(IMessageUpdate gatewayEvent, Cancellation
         if (!messageResult.IsDefined(out var message))
         {
             _ = _channelApi.GetChannelMessageAsync(channelId, messageId, ct);
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         if (message.Content == newContent)
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         // Custom event responders are called earlier than responders responsible for message caching

diff --git a/src/Responders/MessageReceivedResponder.cs b/src/Responders/MessageReceivedResponder.cs
@@ -34,6 +34,6 @@ public Task<Result> RespondAsync(IMessageCreate gatewayEvent, CancellationToken
                 "лан" => "https://i.ibb.co/VYH2QLc/lan.jpg",
                 _ => default(Optional<string>)
             });
-        return Task.FromResult(Result.FromSuccess());
+        return Task.FromResult(Result.Success);
     }
 }
diff --git a/src/Services/Update/MemberUpdateService.cs b/src/Services/Update/MemberUpdateService.cs
@@ -121,7 +121,7 @@ var interactionResult
 
         if (!canInteract)
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var autoUnmuteResult = await TryAutoUnmuteAsync(guildId, id, data, ct);
@@ -148,14 +148,14 @@ private async Task<Result> TryAutoUnbanAsync(
     {
         if (data.BannedUntil is null || DateTimeOffset.UtcNow <= data.BannedUntil)
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var existingBanResult = await _guildApi.GetGuildBanAsync(guildId, id, ct);
         if (!existingBanResult.IsDefined())
         {
             data.BannedUntil = null;
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var unbanResult = await _guildApi.RemoveGuildBanAsync(
@@ -173,7 +173,7 @@ private async Task<Result> TryAutoUnmuteAsync(
     {
         if (data.MutedUntil is null || DateTimeOffset.UtcNow <= data.MutedUntil)
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var unmuteResult = await _guildApi.ModifyGuildMemberAsync(
@@ -209,7 +209,7 @@ private async Task<Result> FilterNicknameAsync(Snowflake guildId, IUser user, IG
 
         if (!usernameChanged)
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var newNickname = string.Concat(characterList.ToArray());
@@ -230,12 +230,13 @@ private async Task<Result> TickReminderAsync(Reminder reminder, IUser user, Memb
     {
         if (DateTimeOffset.UtcNow < reminder.At)
         {
-            return Result.FromSuccess();
+            return Result.Success;
         }
 
         var builder = new StringBuilder()
             .AppendBulletPointLine(string.Format(Messages.DescriptionReminder, Markdown.InlineCode(reminder.Text)))
-            .AppendBulletPointLine(string.Format(Messages.DescriptionActionJumpToMessage, $"https://discord.com/channels/{guildId.Value}/{reminder.ChannelId}/{reminder.MessageId}"));
+            .AppendBulletPointLine(string.Format(Messages.DescriptionActionJumpToMessage,
+                $"https://discord.com/channels/{guildId.Value}/{reminder.ChannelId}/{reminder.MessageId}"));
 
         var embed = new EmbedBuilder().WithSmallTitle(
                 string.Format(Messages.Reminder, user.GetTag()), user)
@@ -251,6 +252,6 @@ private async Task<Result> TickReminderAsync(Reminder reminder, IUser user, Memb
         }
 
         data.Reminders.Remove(reminder);
-        return Result.FromSuccess();
+        return Result.Success;
     }
 }