Add various Discord extension methods

- Better DiscordEmbedBuilder.AddField* overloads
- DiscordEmbedBuilder.WithAuthor
- DiscordMessage.AcknowledgeAsync
- CommandContext.AcknowledgeAsync

BrackeysBot.API/Extensions/CommandContextExtensions.cs

@@ -0,0 +1,19 @@
+using System.Threading.Tasks;
+using DisCatSharp.CommandsNext;
+
+namespace BrackeysBot.API.Extensions;
+
+/// <summary>
+///     Extension methods for <see cref="CommandContext" />.
+/// </summary>
+internal static class CommandContextExtensions
+{
+    /// <summary>
+    ///     Acknowledges the message provided by a <see cref="CommandContext" /> by reacting to it.
+    /// </summary>
+    /// <param name="context">The command context.</param>
+    public static Task AcknowledgeAsync(this CommandContext context)
+    {
+        return context.Message.AcknowledgeAsync();
+    }
+}

BrackeysBot.API/Extensions/DiscordEmbedBuilderExtensions.cs

@@ -0,0 +1,241 @@
+using System;
+using DisCatSharp;
+using DisCatSharp.Entities;
+
+namespace BrackeysBot.API.Extensions;
+
+/// <summary>
+///     Extension methods for <see cref="DiscordEmbedBuilder" />.
+/// </summary>
+public static class DiscordEmbedBuilderExtensions
+{
+    /// <summary>
+    ///     Adds a field of any value to an embed.
+    /// </summary>
+    /// <param name="embedBuilder">The <see cref="DiscordEmbedBuilder" /> to modify.</param>
+    /// <param name="name">The field name.</param>
+    /// <param name="value">The field value.</param>
+    /// <param name="inline"><see langword="true" /> to display the field inline; otherwise, <see langword="false" />.</param>
+    /// <typeparam name="T">The value type of the field.</typeparam>
+    /// <returns><paramref name="embedBuilder" />, to allow for method chaining.</returns>
+    public static DiscordEmbedBuilder AddField<T>(this DiscordEmbedBuilder embedBuilder, string name, T value,
+        bool inline = false)
+    {
+        return embedBuilder.AddField(name, value?.ToString(), inline);
+    }
+
+    /// <summary>
+    ///     Conditionally adds a field to an embed.
+    /// </summary>
+    /// <param name="embedBuilder">The <see cref="DiscordEmbedBuilder" /> to modify.</param>
+    /// <param name="conditionEvaluator">
+    ///     A delegate which returns <see langword="true" /> if the field should be added; otherwise, returns
+    ///     <see langword="false" />.
+    /// </param>
+    /// <param name="name">The field name.</param>
+    /// <param name="value">The field value.</param>
+    /// <param name="inline"><see langword="true" /> to display the field inline; otherwise, <see langword="false" />.</param>
+    /// <typeparam name="T">The value type of the field.</typeparam>
+    /// <returns><paramref name="embedBuilder" />, to allow for method chaining.</returns>
+    public static DiscordEmbedBuilder AddFieldIf<T>(this DiscordEmbedBuilder embedBuilder, Func<bool> conditionEvaluator,
+        string name, T value, bool inline = false)
+    {
+        if (conditionEvaluator is null) throw new ArgumentNullException(nameof(conditionEvaluator));
+
+        if (!conditionEvaluator()) return embedBuilder;
+        return embedBuilder.AddField(name, value, inline);
+    }
+
+    /// <summary>
+    ///     Conditionally adds a field to an embed.
+    /// </summary>
+    /// <param name="embedBuilder">The <see cref="DiscordEmbedBuilder" /> to modify.</param>
+    /// <param name="conditionEvaluator">
+    ///     A delegate which returns <see langword="true" /> if the field should be added; otherwise, returns
+    ///     <see langword="false" />.
+    /// </param>
+    /// <param name="name">The field name.</param>
+    /// <param name="valueEvaluator">The delegate to execute if <paramref name="conditionEvaluator" /> is <see langword="true" />.</param>
+    /// <param name="inline"><see langword="true" /> to display the field inline; otherwise, <see langword="false" />.</param>
+    /// <typeparam name="T">The value type of the field.</typeparam>
+    /// <returns><paramref name="embedBuilder" />, to allow for method chaining.</returns>
+    public static DiscordEmbedBuilder AddFieldIf<T>(this DiscordEmbedBuilder embedBuilder, Func<bool> conditionEvaluator,
+        string name, Func<T> valueEvaluator, bool inline = false)
+    {
+        if (valueEvaluator is null) throw new ArgumentNullException(nameof(valueEvaluator));
+
+        if (!conditionEvaluator()) return embedBuilder;
+        return embedBuilder.AddField(name, valueEvaluator(), inline);
+    }
+
+    /// <summary>
+    ///     Conditionally adds a field to an embed, lazily.
+    /// </summary>
+    /// <param name="embedBuilder">The <see cref="DiscordEmbedBuilder" /> to modify.</param>
+    /// <param name="condition"><see langword="true" /> if the field should be added; otherwise, <see langword="false" />.</param>
+    /// <param name="name">The field name.</param>
+    /// <param name="valueEvaluator">The delegate to execute if <paramref name="condition" /> is <see langword="true" />.</param>
+    /// <param name="inline"><see langword="true" /> to display the field inline; otherwise, <see langword="false" />.</param>
+    /// <typeparam name="T">The value type of the field.</typeparam>
+    /// <returns><paramref name="embedBuilder" />, to allow for method chaining.</returns>
+    public static DiscordEmbedBuilder AddFieldIf<T>(this DiscordEmbedBuilder embedBuilder, bool condition, string name,
+        Func<T> valueEvaluator, bool inline = false)
+    {
+        if (valueEvaluator is null) throw new ArgumentNullException(nameof(valueEvaluator));
+
+        if (!condition) return embedBuilder;
+        return embedBuilder.AddField(name, valueEvaluator(), inline);
+    }
+
+    /// <summary>
+    ///     Conditionally adds a field to an embed.
+    /// </summary>
+    /// <param name="embedBuilder">The <see cref="DiscordEmbedBuilder" /> to modify.</param>
+    /// <param name="condition"><see langword="true" /> if the field should be added; otherwise, <see langword="false" />.</param>
+    /// <param name="name">The field name.</param>
+    /// <param name="value">The field value.</param>
+    /// <param name="inline"><see langword="true" /> to display the field inline; otherwise, <see langword="false" />.</param>
+    /// <typeparam name="T">The value type of the field.</typeparam>
+    /// <returns><paramref name="embedBuilder" />, to allow for method chaining.</returns>
+    public static DiscordEmbedBuilder AddFieldIf<T>(this DiscordEmbedBuilder embedBuilder, bool condition, string name, T value,
+        bool inline = false)
+    {
+        if (!condition) return embedBuilder;
+        return embedBuilder.AddField(name, value, inline);
+    }
+
+    /// <summary>
+    ///     Adds a field to an embed whose value will be one of two values, determined by a specified condition.
+    /// </summary>
+    /// <param name="embedBuilder">The <see cref="DiscordEmbedBuilder" /> to modify.</param>
+    /// <param name="condition">
+    ///     <see langword="true" /> if the value used will be <paramref name="valueIfTrue" />.
+    ///     <see langword="false" /> if the value used will be <paramref name="valueIfFalse" />.
+    /// </param>
+    /// <param name="name">The field name.</param>
+    /// <param name="valueIfTrue">
+    ///     The value to be used as the field value if <paramref name="condition" /> is <see langword="true" />.
+    /// </param>
+    /// <param name="valueIfFalse">
+    ///     The value to be used as the field value if <paramref name="condition" /> is <see langword="false" />.
+    /// </param>
+    /// <param name="inline"><see langword="true" /> to display the field inline; otherwise, <see langword="false" />.</param>
+    /// <typeparam name="TTrue">The type of the truthy value.</typeparam>
+    /// <typeparam name="TFalse">The type of the falsey value.</typeparam>
+    /// <returns><paramref name="embedBuilder" />, to allow for method chaining.</returns>
+    public static DiscordEmbedBuilder AddFieldOrElse<TTrue, TFalse>(this DiscordEmbedBuilder embedBuilder, bool condition,
+        string name, TTrue valueIfTrue, TFalse valueIfFalse, bool inline = false)
+    {
+        return condition
+            ? embedBuilder.AddField(name, valueIfTrue, inline)
+            : embedBuilder.AddField(name, valueIfFalse, inline);
+    }
+
+    /// <summary>
+    ///     Adds a field to an embed whose value will be one of two values, determined by a specified condition.
+    /// </summary>
+    /// <param name="embedBuilder">The <see cref="DiscordEmbedBuilder" /> to modify.</param>
+    /// <param name="condition">
+    ///     <see langword="true" /> if the value used will be determined by <paramref name="valueEvaluatorIfTrue" />; or returns
+    ///     <see langword="false" /> if the value used will be determined by <paramref name="valueEvaluatorIfFalse" />.
+    /// </param>
+    /// <param name="name">The field name.</param>
+    /// <param name="valueEvaluatorIfTrue">
+    ///     The delegate whose return value is used if <paramref name="condition" /> is <see langword="true" />.
+    /// </param>
+    /// <param name="valueEvaluatorIfFalse">
+    ///     The delegate whose return value is used if <paramref name="condition" /> is <see langword="false" />.
+    /// </param>
+    /// <param name="inline"><see langword="true" /> to display the field inline; otherwise, <see langword="false" />.</param>
+    /// <typeparam name="TTrue">The type of the truthy value.</typeparam>
+    /// <typeparam name="TFalse">The type of the falsey value.</typeparam>
+    /// <returns><paramref name="embedBuilder" />, to allow for method chaining.</returns>
+    public static DiscordEmbedBuilder AddFieldOrElse<TTrue, TFalse>(this DiscordEmbedBuilder embedBuilder, bool condition,
+        string name, Func<TTrue> valueEvaluatorIfTrue, Func<TFalse> valueEvaluatorIfFalse, bool inline = false)
+    {
+        if (valueEvaluatorIfTrue is null) throw new ArgumentNullException(nameof(valueEvaluatorIfTrue));
+        if (valueEvaluatorIfFalse is null) throw new ArgumentNullException(nameof(valueEvaluatorIfFalse));
+
+        return condition
+            ? embedBuilder.AddField(name, valueEvaluatorIfTrue(), inline)
+            : embedBuilder.AddField(name, valueEvaluatorIfFalse(), inline);
+    }
+
+    /// <summary>
+    ///     Adds a field to an embed whose value will be one of two values, determined by a specified condition.
+    /// </summary>
+    /// <param name="embedBuilder">The <see cref="DiscordEmbedBuilder" /> to modify.</param>
+    /// <param name="conditionEvaluator">
+    ///     A delegate which returns <see langword="true" /> if the value used will be determined by
+    ///     <paramref name="valueEvaluatorIfTrue" />; or returns <see langword="false" />  if the value used will be determined by
+    ///     <paramref name="valueEvaluatorIfFalse" />.
+    /// </param>
+    /// <param name="name">The field name.</param>
+    /// <param name="valueEvaluatorIfTrue">
+    ///     The delegate whose return value is used as the field value if the value returned by
+    ///     <paramref name="conditionEvaluator" /> is <see langword="true" />.
+    /// </param>
+    /// <param name="valueEvaluatorIfFalse">
+    ///     The delegate whose return value is used as the field value if the value returned by
+    ///     <paramref name="conditionEvaluator" /> is <see langword="false" />.
+    /// </param>
+    /// <param name="inline"><see langword="true" /> to display the field inline; otherwise, <see langword="false" />.</param>
+    /// <typeparam name="TTrue">The type of the truthy value.</typeparam>
+    /// <typeparam name="TFalse">The type of the falsey value.</typeparam>
+    /// <returns><paramref name="embedBuilder" />, to allow for method chaining.</returns>
+    public static DiscordEmbedBuilder AddFieldOrElse<TTrue, TFalse>(this DiscordEmbedBuilder embedBuilder,
+        Func<bool> conditionEvaluator, string name, Func<TTrue> valueEvaluatorIfTrue, Func<TFalse> valueEvaluatorIfFalse,
+        bool inline = false)
+    {
+        if (conditionEvaluator is null) throw new ArgumentNullException(nameof(conditionEvaluator));
+        if (valueEvaluatorIfTrue is null) throw new ArgumentNullException(nameof(valueEvaluatorIfTrue));
+        if (valueEvaluatorIfFalse is null) throw new ArgumentNullException(nameof(valueEvaluatorIfFalse));
+
+        return conditionEvaluator()
+            ? embedBuilder.AddField(name, valueEvaluatorIfTrue(), inline)
+            : embedBuilder.AddField(name, valueEvaluatorIfFalse(), inline);
+    }
+
+    /// <summary>
+    ///     Adds a field to an embed whose value will be one of two values, determined by a specified condition.
+    /// </summary>
+    /// <param name="embedBuilder">The <see cref="DiscordEmbedBuilder" /> to modify.</param>
+    /// <param name="conditionEvaluator">
+    ///     A delegate which returns <see langword="true" /> if the value used will be <paramref name="valueIfTrue" />; or returns
+    ///     <see langword="false" />  if the value used will be <paramref name="valueIfFalse" />.
+    ///     .
+    /// </param>
+    /// <param name="name">The field name.</param>
+    /// <param name="valueIfTrue">
+    ///     The delegate whose return value will be used as the field value if the value returned by
+    ///     <paramref name="conditionEvaluator" /> is <see langword="true" />.
+    /// </param>
+    /// <param name="valueIfFalse">
+    ///     The delegate whose return value will be used as the field value if the value returned by
+    ///     <paramref name="conditionEvaluator" /> is <see langword="false" />.
+    /// </param>
+    /// <param name="inline"><see langword="true" /> to display the field inline; otherwise, <see langword="false" />.</param>
+    /// <typeparam name="TTrue">The type of the truthy value.</typeparam>
+    /// <typeparam name="TFalse">The type of the falsey value.</typeparam>
+    /// <returns><paramref name="embedBuilder" />, to allow for method chaining.</returns>
+    public static DiscordEmbedBuilder AddFieldOrElse<TTrue, TFalse>(this DiscordEmbedBuilder embedBuilder,
+        Func<bool> conditionEvaluator, string name, TTrue valueIfTrue, TFalse valueIfFalse, bool inline = false)
+    {
+        if (conditionEvaluator is null) throw new ArgumentNullException(nameof(conditionEvaluator));
+
+        return conditionEvaluator()
+            ? embedBuilder.AddField(name, valueIfTrue, inline)
+            : embedBuilder.AddField(name, valueIfFalse, inline);
+    }
+
+    /// <summary>
+    ///     Sets the embed's author to a specified <see cref="DiscordUser" />.
+    /// </summary>
+    /// <param name="embedBuilder">The embed builder to modify.</param>
+    /// <param name="author">The author.</param>
+    /// <returns><paramref name="embedBuilder" />, to allow for method chaining.</returns>
+    public static DiscordEmbedBuilder WithAuthor(this DiscordEmbedBuilder embedBuilder, DiscordUser author)
+    {
+        return embedBuilder.WithAuthor(author.UsernameWithDiscriminator, iconUrl: author.GetAvatarUrl(ImageFormat.Png));
+    }
+}

BrackeysBot.API/Extensions/DiscordMessageExtensions.cs

@@ -0,0 +1,19 @@
+using System.Threading.Tasks;
+using DisCatSharp.Entities;
+
+namespace BrackeysBot.API.Extensions;
+
+/// <summary>
+///     Extension methods for <see cref="DiscordMessage" />.
+/// </summary>
+internal static class DiscordMessageExtensions
+{
+    /// <summary>
+    ///     Acknowledges a message by reacting to it.
+    /// </summary>
+    /// <param name="message">The message to acknowledge.</param>
+    public static Task AcknowledgeAsync(this DiscordMessage message)
+    {
+        return message.CreateReactionAsync(DiscordEmoji.FromUnicode("✅"));
+    }
+}