Merge pull request #66 from InfinityGhost/embed-improvements

Improve appearance of embeds

Author: InfinityGhost

TabletBot.Discord/Commands/GitHubCommands.cs

@@ -67,8 +67,8 @@ from pr in await _gitHubClient.PullRequest.GetAllForRepository(repo.Id)
         public async Task GetPullRequest([Remainder] int id)
         {
             var message = await ReplyAsync($"Fetching pull request #{id}");
-            var pr = await _gitHubClient.PullRequest.Get(REPOSITORY_OWNER, REPOSITORY_NAME, id);
-            var embed = GitHubEmbeds.GetPullRequestEmbed(pr);
+            var pr = await _gitHubClient.Issue.Get(REPOSITORY_OWNER, REPOSITORY_NAME, id);
+            var embed = GitHubEmbeds.GetEmbed(pr);
             await message.Update(embed);
         }
 
@@ -77,7 +77,7 @@ public async Task GetIssue([Remainder] int id)
         {
             var message = await ReplyAsync($"Fetching issue #{id}");
             var issue = await _gitHubClient.Issue.Get(REPOSITORY_OWNER, REPOSITORY_NAME, id);
-            var embed = GitHubEmbeds.GetIssueEmbed(issue);
+            var embed = GitHubEmbeds.GetEmbed(issue);
             await message.Update(embed);
         }
 

TabletBot.Discord/Commands/SnippetCommands.cs

@@ -146,12 +146,7 @@ public async Task ExportSnippet(string prefix)
 
             if (Snippets.FirstOrDefault(s => s.Snippet == prefix) is SnippetStore snippet)
             {
-                var sb = new StringBuilder();
-                sb.AppendLine(Formatting.CODE_BLOCK);
-                sb.AppendLine(snippet.Content);
-                sb.AppendLine(Formatting.CODE_BLOCK);
-
-                await ReplyAsync(sb.ToString());
+                await ReplyAsync(Formatting.CodeBlock(snippet.Content));
             }
             else
             {

TabletBot.Discord/Embeds/GitHubEmbeds.cs

@@ -1,42 +1,75 @@
-using Discord;
+using System.Collections.Generic;
+using System.Linq;
+using Discord;
 using Octokit;
 
 namespace TabletBot.Discord.Embeds
 {
     public static class GitHubEmbeds
     {
-        public static Embed GetIssueEmbed(Issue issue)
+        private const uint OPEN_COLOR = 0x238636;
+        private const uint RESOLVED_COLOR = 0x8957e5;
+        private const uint CLOSED_COLOR = 0xda3633;
+
+        public static EmbedBuilder GetEmbed(Issue? issue)
         {
-            var embed = new EmbedBuilder
+            if (issue == null)
+            {
+                return new EmbedBuilder()
+                {
+                    Color = CLOSED_COLOR,
+                    Description = "No issue or pull request was found."
+                };
+            }
+
+            return new EmbedBuilder
             {
-                Title = string.Format("{0} #{1}", issue.Title, issue.Number),
-                Timestamp = issue.CreatedAt,
+                Title = $"{issue.Title} #{issue.Number}",
                 Url = issue.HtmlUrl,
-                Footer = new EmbedFooterBuilder
+                Description = issue.Body ?? string.Empty,
+                Color = GetColor(issue),
+                Fields = GetFields(issue).ToList(),
+                Author = new EmbedAuthorBuilder
                 {
-                    Text = string.Format("{0} opened this issue on {1}", issue.User.Login, issue.CreatedAt),
+                    Name = issue.User.Login,
+                    Url = issue.User.HtmlUrl,
                     IconUrl = issue.User.AvatarUrl
-                },
-                Description = issue.Body
+                }
             };
-            return embed.Build();
         }
 
-        public static Embed GetPullRequestEmbed(PullRequest pr)
+        private static uint GetColor(Issue issue)
         {
-            var embed = new EmbedBuilder
+            if (issue.ClosedAt == null)
+                return OPEN_COLOR;
+
+            if (issue.PullRequest != null)
+                return issue.PullRequest.Merged ? RESOLVED_COLOR : CLOSED_COLOR;
+
+            return RESOLVED_COLOR;
+        }
+
+        private static IEnumerable<EmbedFieldBuilder> GetFields(Issue issue)
+        {
+            if (issue.Milestone != null)
             {
-                Title = $"{pr.Title} #{pr.Number}",
-                Timestamp = pr.UpdatedAt,
-                Url = pr.HtmlUrl,
-                Footer = new EmbedFooterBuilder
+                yield return new EmbedFieldBuilder
                 {
-                    Text = $"{pr.User?.Login} opened this pull request on {pr.CreatedAt}",
-                    IconUrl = pr.User?.AvatarUrl
-                },
-                Description = pr.Body ?? string.Empty
-            };
-            return embed.Build();
+                    Name = "Milestone",
+                    Value = Formatting.UrlString(issue.Milestone.Title, issue.Milestone.HtmlUrl),
+                    IsInline = true
+                };
+            }
+
+            if (issue.Labels.Any())
+            {
+                yield return new EmbedFieldBuilder
+                {
+                    Name = "Labels",
+                    Value = string.Join(", ", issue.Labels.Select(l => Formatting.CodeString(l.Name))),
+                    IsInline = true
+                };
+            }
         }
     }
 }

TabletBot.Discord/Embeds/SnippetEmbeds.cs

@@ -25,8 +25,7 @@ public static bool GetSnippetEmbed(Settings settings, string? prefix, out EmbedB
             {
                 Color = Color.Red,
                 Title = "Failed to show snippet",
-                Description = $"Failed to show the `{prefix}` snippet." + Environment.NewLine
-                                                                        + "Verify that you have spelled it correctly."
+                Description = $"Failed to show the `{prefix}` snippet." + Environment.NewLine + "Verify that you have spelled it correctly."
             };
             return false;
         }

TabletBot.Discord/Formatting.cs

@@ -1,3 +1,4 @@
+using System;
 using Discord;
 
 namespace TabletBot.Discord
@@ -11,6 +12,11 @@ public static class Formatting
         public const string QUOTE_PREFIX = "> ";
         public const string CODE_BLOCK = "```";
 
-        public static string UrlString(IAttachment attachment) => $"[{attachment.Filename}]({attachment.Url})";
+        public static string UrlString(IAttachment attachment) => UrlString(attachment.Filename, attachment.Url);
+        public static string UrlString(string text, string url) => $"[{text}]({url})";
+
+        public static string CodeString(string text) => $"{CODE_AFFIX}{text}{CODE_AFFIX}";
+        public static string CodeBlock(string text, string? lang = null) =>
+            $"{CODE_BLOCK}{lang}{Environment.NewLine}{text}{Environment.NewLine}{CODE_BLOCK}";
     }
 }

TabletBot.Discord/SlashCommands/SnippetSlashCommands.cs

@@ -215,10 +215,8 @@ private async Task ExportSnippet(SocketSlashCommand command)
             if (Snippets.FirstOrDefault(s => s.Snippet == snippet) is SnippetStore store)
             {
                 var sb = new StringBuilder();
-                sb.AppendLine(Formatting.CODE_AFFIX + store.Title + Formatting.CODE_AFFIX);
-                sb.AppendLine(Formatting.CODE_BLOCK);
-                sb.AppendLine(store.Content.Replace(Environment.NewLine, @"\n"));
-                sb.AppendLine(Formatting.CODE_BLOCK);
+                sb.AppendLine(Formatting.CodeString(store.Title));
+                sb.AppendLine(Formatting.CodeBlock(store.Content.Replace(Environment.NewLine, @"\n")));
 
                 await command.FollowupAsync(sb.ToString());
             }

TabletBot.Discord/Watchers/GitHub/IssueMessageWatcher.cs

@@ -1,4 +1,6 @@
+using System.Collections;
 using System.Collections.Generic;
+using System.Dynamic;
 using System.Linq;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
@@ -50,25 +52,17 @@ public async Task Receive(IMessage message)
 
         private async Task ReplyWithEmbeds(IUserMessage message, IList<uint> refs)
         {
-            var issues = await _gitHubClient.Issue.GetAllForRepository(OWNER, NAME);
-            var prs = await _gitHubClient.PullRequest.GetAllForRepository(OWNER, NAME);
-            var embeds = GetEmbedsForRefs(issues, prs, refs).ToArray();
+            var embeds = new Embed[refs.Count];
 
-            await message.Channel.SendMessageAsync(embeds: embeds, messageReference: message.ToReference());
-        }
-
-        private IEnumerable<Embed> GetEmbedsForRefs(IReadOnlyList<Issue> issues, IReadOnlyList<PullRequest> prs, IList<uint> refs)
-        {
             for (var i = 0; i < refs.Count && i < _settings.GitHubIssueRefLimit; i++)
             {
-                var issueRef = refs[i];
+                var issueRef = (int)refs[i];
+                var issue = await _gitHubClient.Issue.Get(OWNER, NAME, issueRef);
 
-                if (issues.FirstOrDefault(s => s.Number == issueRef) is Issue issue)
-                {
-                    var pr = prs.FirstOrDefault(pr => pr.Number == issue.Number);
-                    yield return pr == null ? GitHubEmbeds.GetIssueEmbed(issue) : GitHubEmbeds.GetPullRequestEmbed(pr);
-                }
+                embeds[i] = GitHubEmbeds.GetEmbed(issue).Build();
             }
+
+            await message.Channel.SendMessageAsync(embeds: embeds.ToArray(), messageReference: message.ToReference());
         }
 
         private static IEnumerable<uint>? GetIssueRefNumbers(string message)