Instead of implementing the IService interface, Services now have an attribute with Name and Purpose properties.

GreemDev · GreemDev · commit 59a99f5d8291 · 2019-03-15T11:26:20.000-05:00
Also added ReflectionExtensions, and fixed up the DIExtensions class to reflect the changes made in this commit.
diff --git a/src/Commands/Modules/Admin/SelfRoleCommands.cs b/src/Commands/Modules/Admin/SelfRoleCommands.cs
@@ -11,7 +11,7 @@ public partial class AdminModule : VolteModule
     {
         [Command("SelfRoleAdd", "SrA", "SrAdd")]
         [Description("Adds a role to the list of self roles for this guild.")]
-        [Remarks("Usage: |prefix|selfroleadd {roleName}")]
+        [Remarks("Usage: |prefix|selfroleadd {role}")]
         [RequireGuildAdmin]
         public async Task SelfRoleAddAsync([Remainder] SocketRole role)
         {
@@ -24,13 +24,13 @@ public async Task SelfRoleAddAsync([Remainder] SocketRole role)
 
         [Command("SelfRoleRemove", "SrR", "SrRem")]
         [Description("Removes a role from the list of self roles for this guild.")]
-        [Remarks("Usage: |prefix|selfrole remove {roleName}")]
+        [Remarks("Usage: |prefix|selfrole remove {role}")]
         [RequireGuildAdmin]
         public async Task SelfRoleRemAsync([Remainder] SocketRole role)
         {
             var config = Db.GetConfig(Context.Guild);
 
-            if (config.SelfRoles.Any(x => x.EqualsIgnoreCase(role.Name)))
+            if (config.SelfRoles.ContainsIgnoreCase(role.Name))
             {
                 config.SelfRoles.Remove(role.Name);
                 await Context.CreateEmbed($"Removed **{role.Name}** from the Self Roles list for this guild.")
diff --git a/src/Commands/Modules/Owner/EvalCommand.cs b/src/Commands/Modules/Owner/EvalCommand.cs
@@ -48,9 +48,10 @@ await ExecutorUtil.ExecuteAsync(async () =>
 
                     var imports = new[]
                     {
-                        "System", "System.Collections.Generic", "System.Linq", "System.Text", "System.Threading.Tasks",
-                        "System.Diagnostics", "Discord", "Qmmands", "Discord.WebSocket", "System.IO",
-                        "System.Threading", "Volte.Extensions", "Volte.Utils", "Volte.Runtime", "Volte.Data"
+                        "System", "System.Collections.Generic", "System.Linq", "System.Text",
+                        "System.Diagnostics", "Discord", "Discord.WebSocket", "System.IO", "Volte.Data",
+                        "System.Threading", "Volte.Extensions", "Volte.Utils", "Volte.Runtime",
+                        "Volte.Discord", "Volte.Services", "System.Threading.Tasks", "Qmmands"
                     };
 
                     sopts = sopts.WithImports(imports).WithReferences(AppDomain.CurrentDomain.GetAssemblies()
diff --git a/src/Extensions/DependencyInjectionExtensions.cs b/src/Extensions/DependencyInjectionExtensions.cs
@@ -2,7 +2,6 @@
 using System.Linq;
 using System.Reflection;
 using Microsoft.Extensions.DependencyInjection;
-using RestSharp.Extensions;
 using Volte.Services;
 
 namespace Volte.Extensions
@@ -13,9 +12,8 @@ public static IServiceCollection AddVolteServices(this IServiceCollection provid
         {
             //get all the classes that implement the IService interface, arent an interface themselves, and haven't been marked as Obsolete like the GitHubService.
             foreach (var service in Assembly.GetEntryAssembly().GetTypes()
-                .Where(t => typeof(IService).IsAssignableFrom(t) && 
-                            !t.IsInterface &&
-                            t.GetAttribute<ObsoleteAttribute>() == null))
+                .Where(t => !t.HasAttribute<ObsoleteAttribute>() &&
+                            t.HasAttribute<ServiceAttribute>()))
             {
                 provider.AddSingleton(service);
             }
diff --git a/src/Extensions/ReflectionExtensions.cs b/src/Extensions/ReflectionExtensions.cs
@@ -0,0 +1,17 @@
+﻿using System;
+using System.Reflection;
+using RestSharp.Extensions;
+
+namespace Volte.Extensions
+{
+    public static class ReflectionExtensions
+    {
+
+        public static bool HasAttribute<T>(this TypeInfo type) where T : Attribute
+            => type.GetAttribute<T>() != null;
+
+        public static bool HasAttribute<T>(this Type type) where T : Attribute
+            => type.GetAttribute<T>() != null;
+
+    }
+}
diff --git a/src/Services/AntilinkService.cs b/src/Services/AntilinkService.cs
@@ -2,13 +2,12 @@
 using System.Threading.Tasks;
 using RestSharp;
 using Volte.Commands;
-using Volte.Discord;
 using Volte.Extensions;
-using Volte.Utils;
 
 namespace Volte.Services
 {
-    public sealed class AntilinkService : IService
+    [Service("Antilink", "The main Service for checking links sent in chat.")]
+    public sealed class AntilinkService
     {
         private readonly DatabaseService _db;
 
diff --git a/src/Services/AutoroleService.cs b/src/Services/AutoroleService.cs
@@ -1,12 +1,12 @@
 ﻿using System.Linq;
 using System.Threading.Tasks;
 using Discord;
-using Volte.Discord;
 using Volte.Extensions;
 
 namespace Volte.Services
 {
-    public sealed class AutoroleService : IService
+    [Service("Autorole", "The main Service for automatically applying roles when a user joins any given guild.")]
+    public sealed class AutoroleService
     {
         private readonly DatabaseService _db;
 
diff --git a/src/Services/BlacklistService.cs b/src/Services/BlacklistService.cs
@@ -4,7 +4,8 @@
 
 namespace Volte.Services
 {
-    public sealed class BlacklistService : IService
+    [Service("Blacklist", "The main Service for checking messages for blacklisted words/phrases in user's messages.")]
+    public sealed class BlacklistService
     {
         private readonly DatabaseService _db;
 
diff --git a/src/Services/DatabaseService.cs b/src/Services/DatabaseService.cs
@@ -6,7 +6,8 @@
 
 namespace Volte.Services
 {
-    public sealed class DatabaseService : IService
+    [Service("Database", "The main Service for interacting with the Volte database.")]
+    public sealed class DatabaseService
     {
         public static readonly LiteDatabase Database = new LiteDatabase("data/Volte.db");
 
diff --git a/src/Services/DebugService.cs b/src/Services/DebugService.cs
@@ -2,12 +2,14 @@
 using Newtonsoft.Json;
 using Newtonsoft.Json.Linq;
 using RestSharp;
+using Volte.Extensions;
 
 namespace Volte.Services
 {
-    public sealed class DebugService : IService
+    [Service("Debug", "The main Service that handles HTTP POST requests for debug reports to debug.scarsz.me.")]
+    public sealed class DebugService
     {
-        public string Execute(string config)
+        public string Execute(string json)
         {
             var files = new Dictionary<string, Dictionary<string, string>>
             {
@@ -27,7 +29,7 @@ public string Execute(string config)
                     "2-Server.conf", new Dictionary<string, string>
                     {
                         {
-                            "content", config
+                            "content", json
                         },
                         {
                             "description", "Server config for debug purposes."
@@ -47,9 +49,8 @@ public string Execute(string config)
             req.RequestFormat = DataFormat.Json;
             req.Parameters.Clear();
             req.AddParameter("application/json", JsonConvert.SerializeObject(payload), ParameterType.RequestBody);
-            return ((JObject) JsonConvert
-                    .DeserializeObject(httpClient.Execute(req).Content))
-                .GetValue("url").ToString();
+            return JsonConvert.DeserializeObject(httpClient.Execute(req).Content).Cast<JObject>().GetValue("url")
+                .ToString();
         }
     }
 }
diff --git a/src/Services/DefaultWelcomeService.cs b/src/Services/DefaultWelcomeService.cs
@@ -4,7 +4,8 @@
 
 namespace Volte.Services
 {
-    public sealed class DefaultWelcomeService : IService
+    [Service("DefaultWelcome", "The main Service that handles default welcome/leaving functionality when no WelcomeApiKey is set in the bot config.")]
+    public sealed class DefaultWelcomeService
     {
         private readonly DatabaseService _db;
 
@@ -23,7 +24,9 @@ internal async Task JoinAsync(IGuildUser user)
                 .Replace("{UserName}", user.Username)
                 .Replace("{UserMention}", user.Mention)
                 .Replace("{OwnerMention}", (await user.Guild.GetOwnerAsync()).Mention)
-                .Replace("{UserTag}", user.Discriminator);
+                .Replace("{UserTag}", user.Discriminator)
+                .Replace("{MemberCount}", (await user.Guild.GetUsersAsync()).Count.ToString())
+                .Replace("{UserString}", user.ToString());
             var c = await user.Guild.GetTextChannelAsync(config.WelcomeOptions.WelcomeChannel);
 
             if (!(c is null))
@@ -48,12 +51,15 @@ internal async Task LeaveAsync(IGuildUser user)
                 .Replace("{UserName}", user.Username)
                 .Replace("{UserMention}", user.Mention)
                 .Replace("{OwnerMention}", (await user.Guild.GetOwnerAsync()).Mention)
-                .Replace("{UserTag}", user.Discriminator);
+                .Replace("{UserTag}", user.Discriminator)
+                .Replace("{MemberCount}", (await user.Guild.GetUsersAsync()).Count.ToString())
+                .Replace("{UserString}", user.ToString());
             var c = await user.Guild.GetTextChannelAsync(config.WelcomeOptions.WelcomeChannel);
             if (!(c is null))
             {
                 var embed = new EmbedBuilder()
-                    .WithColor(new Color(config.WelcomeOptions.WelcomeColorR,
+                    .WithColor(new Color(
+                        config.WelcomeOptions.WelcomeColorR,
                         config.WelcomeOptions.WelcomeColorG,
                         config.WelcomeOptions.WelcomeColorB)
                     )
diff --git a/src/Services/EmojiService.cs b/src/Services/EmojiService.cs
@@ -3,7 +3,8 @@ namespace Volte.Services
     // ReSharper disable UnusedMember.Global
     // ReSharper disable IdentifierTypo
     // ReSharper disable InconsistentNaming
-    public sealed class EmojiService : IService
+    [Service("Emoji", "The main Service that has properties for all twemoji emojis used by Discord.")]
+    public sealed class EmojiService
     {
         public string A { get; } = "\uD83C\uDD70";
         public string AB { get; } = "\uD83C\uDD8E";
diff --git a/src/Services/EventService.cs b/src/Services/EventService.cs
@@ -3,7 +3,6 @@
 using System.Linq;
 using System.Threading.Tasks;
 using Discord;
-using Discord.WebSocket;
 using Humanizer;
 using Qmmands;
 using Volte.Commands;
@@ -13,7 +12,8 @@
 
 namespace Volte.Services
 {
-    public sealed class EventService : IService
+    [Service("Event", "The main Service for handling some Discord gateway events.")]
+    public sealed class EventService
     {
         private readonly LoggingService _logger;
 
diff --git a/src/Services/GitHubService.cs b/src/Services/GitHubService.cs
@@ -2,8 +2,8 @@
 
 namespace Volte.Services
 {
-    [Obsolete]
-    public sealed class GitHubService : IService
+    [Obsolete, Service("GitHub", "The main Service for using the GitHub API.")]
+    public sealed class GitHubService
     {/*
         public static readonly GitHubClient GitHub = new GitHubClient(new ProductHeaderValue("GreemDev"));
 
diff --git a/src/Services/GuildService.cs b/src/Services/GuildService.cs
@@ -11,7 +11,8 @@
 
 namespace Volte.Services
 {
-    public sealed class GuildService : IService
+    [Service("Guild", "The main Service that handles guild-related Discord gateway events.")]
+    public sealed class GuildService
     {
         private readonly LoggingService _logger;
 
diff --git a/src/Services/IService.cs b/src/Services/IService.cs
diff --git a/src/Services/ImageWelcomeService.cs b/src/Services/ImageWelcomeService.cs
@@ -1,15 +1,14 @@
 ﻿using System.Net.Http;
 using System.Threading.Tasks;
-using Discord.WebSocket;
-using Volte.Discord;
 using Discord;
 using Volte.Data;
 using Volte.Extensions;
 using Color = System.Drawing.Color;
 
 namespace Volte.Services
 {
-    public sealed class ImageWelcomeService : IService
+    [Service("ImageWelcome", "The main Service used for getting images from the welcome image API to be used for welcoming when the WelcomeApiKey config entry is set.")]
+    public sealed class ImageWelcomeService
     {
         private readonly DatabaseService _db;
         private readonly string _url;
diff --git a/src/Services/LoggingService.cs b/src/Services/LoggingService.cs
@@ -10,7 +10,8 @@
 
 namespace Volte.Services
 {
-    public sealed class LoggingService : IService
+    [Service("Logging", "The main Service used to handle logging to the bot's console.")]
+    public sealed class LoggingService
     {
         private readonly SemaphoreSlim _semaphore = new SemaphoreSlim(1, 1);
 
diff --git a/src/Services/PingChecksService.cs b/src/Services/PingChecksService.cs
@@ -4,7 +4,8 @@
 
 namespace Volte.Services
 {
-    public sealed class PingChecksService : IService
+    [Service("PingChecks", "The main Service used for checking if any given message contains mass mentions.")]
+    public sealed class PingChecksService
     {
         private readonly DatabaseService _db;
 
diff --git a/src/Services/ServiceAttribute.cs b/src/Services/ServiceAttribute.cs
@@ -0,0 +1,20 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Text;
+
+namespace Volte.Services
+{
+    [AttributeUsage(AttributeTargets.Class)]
+    public sealed class ServiceAttribute : Attribute
+    {
+        public string Name { get; }
+        public string Purpose { get; }
+
+        public ServiceAttribute(string name, string purpose)
+        {
+            Name = name;
+            Purpose = purpose;
+        }
+
+    }
+}
diff --git a/src/Services/VerificationService.cs b/src/Services/VerificationService.cs
@@ -4,7 +4,8 @@
 
 namespace Volte.Services
 {
-    public sealed class VerificationService : IService
+    [Service("Verification", "The main Service that handles user verification.")]
+    public sealed class VerificationService
     {
         private readonly DatabaseService _db;
         private readonly EmojiService _emoji;

Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ public partial class AdminModule : VolteModule`
`11`	`11`	`{`
`12`	`12`	`[Command("SelfRoleAdd", "SrA", "SrAdd")]`
`13`	`13`	`[Description("Adds a role to the list of self roles for this guild.")]`
`14`		`- [Remarks("Usage: \|prefix\|selfroleadd {roleName}")]`
	`14`	`+ [Remarks("Usage: \|prefix\|selfroleadd {role}")]`
`15`	`15`	`[RequireGuildAdmin]`
`16`	`16`	`public async Task SelfRoleAddAsync([Remainder] SocketRole role)`
`17`	`17`	`{`
`@@ -24,13 +24,13 @@ public async Task SelfRoleAddAsync([Remainder] SocketRole role)`
`24`	`24`
`25`	`25`	`[Command("SelfRoleRemove", "SrR", "SrRem")]`
`26`	`26`	`[Description("Removes a role from the list of self roles for this guild.")]`
`27`		`- [Remarks("Usage: \|prefix\|selfrole remove {roleName}")]`
	`27`	`+ [Remarks("Usage: \|prefix\|selfrole remove {role}")]`
`28`	`28`	`[RequireGuildAdmin]`
`29`	`29`	`public async Task SelfRoleRemAsync([Remainder] SocketRole role)`
`30`	`30`	`{`
`31`	`31`	`var config = Db.GetConfig(Context.Guild);`
`32`	`32`
`33`		`- if (config.SelfRoles.Any(x => x.EqualsIgnoreCase(role.Name)))`
	`33`	`+ if (config.SelfRoles.ContainsIgnoreCase(role.Name))`
`34`	`34`	`{`
`35`	`35`	`config.SelfRoles.Remove(role.Name);`
`36`	`36`	`await Context.CreateEmbed($"Removed {role.Name} from the Self Roles list for this guild.")`
Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@`
`2`	`2`	`using System.Linq;`
`3`	`3`	`using System.Reflection;`
`4`	`4`	`using Microsoft.Extensions.DependencyInjection;`
`5`		`-using RestSharp.Extensions;`
`6`	`5`	`using Volte.Services;`
`7`	`6`
`8`	`7`	`namespace Volte.Extensions`
`@@ -13,9 +12,8 @@ public static IServiceCollection AddVolteServices(this IServiceCollection provid`
`13`	`12`	`{`
`14`	`13`	`//get all the classes that implement the IService interface, arent an interface themselves, and haven't been marked as Obsolete like the GitHubService.`
`15`	`14`	`foreach (var service in Assembly.GetEntryAssembly().GetTypes()`
`16`		`- .Where(t => typeof(IService).IsAssignableFrom(t) &&`
`17`		`- !t.IsInterface &&`
`18`		`- t.GetAttribute<ObsoleteAttribute>() == null))`
	`15`	`+ .Where(t => !t.HasAttribute<ObsoleteAttribute>() &&`
	`16`	`+ t.HasAttribute<ServiceAttribute>()))`
`19`	`17`	`{`
`20`	`18`	`provider.AddSingleton(service);`
`21`	`19`	`}`
Original file line number	Diff line number	Diff line change
`@@ -2,13 +2,12 @@`
`2`	`2`	`using System.Threading.Tasks;`
`3`	`3`	`using RestSharp;`
`4`	`4`	`using Volte.Commands;`
`5`		`-using Volte.Discord;`
`6`	`5`	`using Volte.Extensions;`
`7`		`-using Volte.Utils;`
`8`	`6`
`9`	`7`	`namespace Volte.Services`
`10`	`8`	`{`
`11`		`- public sealed class AntilinkService : IService`
	`9`	`+ [Service("Antilink", "The main Service for checking links sent in chat.")]`
	`10`	`+ public sealed class AntilinkService`
`12`	`11`	`{`
`13`	`12`	`private readonly DatabaseService _db;`
`14`	`13`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,12 @@`
`1`	`1`	`using System.Linq;`
`2`	`2`	`using System.Threading.Tasks;`
`3`	`3`	`using Discord;`
`4`		`-using Volte.Discord;`
`5`	`4`	`using Volte.Extensions;`
`6`	`5`
`7`	`6`	`namespace Volte.Services`
`8`	`7`	`{`
`9`		`- public sealed class AutoroleService : IService`
	`8`	`+ [Service("Autorole", "The main Service for automatically applying roles when a user joins any given guild.")]`
	`9`	`+ public sealed class AutoroleService`
`10`	`10`	`{`
`11`	`11`	`private readonly DatabaseService _db;`
`12`	`12`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,8 @@`
`4`	`4`
`5`	`5`	`namespace Volte.Services`
`6`	`6`	`{`
`7`		`- public sealed class BlacklistService : IService`
	`7`	`+ [Service("Blacklist", "The main Service for checking messages for blacklisted words/phrases in user's messages.")]`
	`8`	`+ public sealed class BlacklistService`
`8`	`9`	`{`
`9`	`10`	`private readonly DatabaseService _db;`
`10`	`11`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,8 @@`
`6`	`6`
`7`	`7`	`namespace Volte.Services`
`8`	`8`	`{`
`9`		`- public sealed class DatabaseService : IService`
	`9`	`+ [Service("Database", "The main Service for interacting with the Volte database.")]`
	`10`	`+ public sealed class DatabaseService`
`10`	`11`	`{`
`11`	`12`	`public static readonly LiteDatabase Database = new LiteDatabase("data/Volte.db");`
`12`	`13`
Original file line number	Diff line number	Diff line change
`@@ -2,12 +2,14 @@`
`2`	`2`	`using Newtonsoft.Json;`
`3`	`3`	`using Newtonsoft.Json.Linq;`
`4`	`4`	`using RestSharp;`
	`5`	`+using Volte.Extensions;`
`5`	`6`
`6`	`7`	`namespace Volte.Services`
`7`	`8`	`{`
`8`		`- public sealed class DebugService : IService`
	`9`	`+ [Service("Debug", "The main Service that handles HTTP POST requests for debug reports to debug.scarsz.me.")]`
	`10`	`+ public sealed class DebugService`
`9`	`11`	`{`
`10`		`- public string Execute(string config)`
	`12`	`+ public string Execute(string json)`
`11`	`13`	`{`
`12`	`14`	`var files = new Dictionary<string, Dictionary<string, string>>`
`13`	`15`	`{`
`@@ -27,7 +29,7 @@ public string Execute(string config)`
`27`	`29`	`"2-Server.conf", new Dictionary<string, string>`
`28`	`30`	`{`
`29`	`31`	`{`
`30`		`- "content", config`
	`32`	`+ "content", json`
`31`	`33`	`},`
`32`	`34`	`{`
`33`	`35`	`"description", "Server config for debug purposes."`
`@@ -47,9 +49,8 @@ public string Execute(string config)`
`47`	`49`	`req.RequestFormat = DataFormat.Json;`
`48`	`50`	`req.Parameters.Clear();`
`49`	`51`	`req.AddParameter("application/json", JsonConvert.SerializeObject(payload), ParameterType.RequestBody);`
`50`		`- return ((JObject) JsonConvert`
`51`		`- .DeserializeObject(httpClient.Execute(req).Content))`
`52`		`- .GetValue("url").ToString();`
	`52`	`+ return JsonConvert.DeserializeObject(httpClient.Execute(req).Content).Cast<JObject>().GetValue("url")`
	`53`	`+ .ToString();`
`53`	`54`	`}`
`54`	`55`	`}`
`55`	`56`	`}`