Extract Plugin members to IPlugin interface

Plugin renamed to MonoPlugin, whereas IPluginManager now exposes methods which accept and return IPlugin. This opens up the door for other possible plugin implementation systems, like Java or Lua. It's unlikely these will ever actually exist... but portability is good.

Yes, I like to over-engineer code. Don't @ me

Author: oliverbooth

BrackeysBot.API/Exceptions/PluginNotLoadedException.cs

@@ -8,7 +8,7 @@ namespace BrackeysBot.API.Exceptions;
 /// </summary>
 public sealed class PluginNotLoadedException : Exception
 {
-    internal PluginNotLoadedException(Plugin plugin)
+    internal PluginNotLoadedException(IPlugin plugin)
         : base($"{plugin} is not loaded.")
     {
         Plugin = plugin;
@@ -18,5 +18,5 @@ internal PluginNotLoadedException(Plugin plugin)
     ///     Gets the plugin.
     /// </summary>
     /// <value>The plugin.</value>
-    public Plugin Plugin { get; }
+    public IPlugin Plugin { get; }
 }

BrackeysBot.API/Plugins/IPlugin.cs

@@ -0,0 +1,42 @@
+using System;
+using System.IO;
+using BrackeysBot.API.Configuration;
+using NLog;
+
+namespace BrackeysBot.API.Plugins;
+
+/// <summary>
+///     Represents a bot plugin.
+/// </summary>
+public interface IPlugin : IDisposable, IConfigurationHolder
+{
+    /// <summary>
+    ///     Gets the data directory for this plugin.
+    /// </summary>
+    /// <value>The data directory.</value>
+    DirectoryInfo DataDirectory { get; }
+
+    /// <summary>
+    ///     Gets the logger for this plugin.
+    /// </summary>
+    /// <value>The plugin's logger.</value>
+    ILogger Logger { get; }
+
+    /// <summary>
+    ///     Gets the information about this plugin.
+    /// </summary>
+    /// <value>A <see cref="BrackeysBot.API.Plugins.PluginInfo" /> object containing</value>
+    PluginInfo PluginInfo { get; }
+
+    /// <summary>
+    ///     Gets the manager which owns this plugin.
+    /// </summary>
+    /// <value>The plugin manager.</value>
+    IPluginManager PluginManager { get; }
+
+    /// <summary>
+    ///     Gets the service provider for this plugin.
+    /// </summary>
+    /// <value>The service provider.</value>
+    public IServiceProvider ServiceProvider { get; }
+}

BrackeysBot.API/Plugins/IPluginManager.cs

@@ -11,16 +11,16 @@ namespace BrackeysBot.API.Plugins;
 public interface IPluginManager
 {
     /// <summary>
-    ///     Gets a read-only view of the plugins enabled by this bot.
+    ///     Gets a read-only view of the plugins enabled by this manager.
     /// </summary>
-    /// <value>A read-only view of <see cref="Plugin" /> instances.</value>
-    IReadOnlyList<Plugin> EnabledPlugins { get; }
+    /// <value>A read-only view of <see cref="IPlugin" /> instances which are currently enabled.</value>
+    IReadOnlyList<IPlugin> EnabledPlugins { get; }
 
     /// <summary>
-    ///     Gets a read-only view of the plugins loaded by this bot.
+    ///     Gets a read-only view of the plugins loaded by this manager.
     /// </summary>
-    /// <value>A read-only view of <see cref="Plugin" /> instances.</value>
-    IReadOnlyList<Plugin> LoadedPlugins { get; }
+    /// <value>A read-only view of <see cref="IPlugin" /> instances which are currently loaded.</value>
+    IReadOnlyList<IPlugin> LoadedPlugins { get; }
 
     /// <summary>
     ///     Gets the logger for this plugin manager.
@@ -34,24 +34,24 @@ public interface IPluginManager
     /// <param name="plugin">The plugin to disable.</param>
     /// <exception cref="ArgumentNullException"><paramref name="plugin" /> is <see langword="null" />.</exception>
     /// <exception cref="PluginNotLoadedException"><paramref name="plugin" /> refers to a plugin that is not loaded.</exception>
-    void DisablePlugin(Plugin plugin);
+    void DisablePlugin(IPlugin plugin);
 
     /// <summary>
     ///     Enables a plugin.
     /// </summary>
     /// <param name="plugin">The plugin to enable.</param>
     /// <exception cref="ArgumentNullException"><paramref name="plugin" /> is <see langword="null" />.</exception>
     /// <exception cref="PluginNotLoadedException"><paramref name="plugin" /> refers to a plugin that is not loaded.</exception>
-    void EnablePlugin(Plugin plugin);
+    void EnablePlugin(IPlugin plugin);
 
     /// <summary>
     ///     Attempts to find a plugin by its type.
     /// </summary>
     /// <typeparam name="T">The plugin type.</typeparam>
     /// <returns>
-    ///     The plugin, or <see langword="null" /> if the plugin with the specified type was not found, or is not loaded.
+    ///     The plugin, or <see langword="default" /> if the plugin with the specified type was not found, or is not loaded.
     /// </returns>
-    T? GetPlugin<T>() where T : Plugin;
+    T? GetPlugin<T>() where T : IPlugin;
 
     /// <summary>
     ///     Attempts to find a plugin by its name.
@@ -60,33 +60,33 @@ public interface IPluginManager
     /// <returns>
     ///     The plugin, or <see langword="null" /> if the plugin with the specified name was not found, or is not loaded.
     /// </returns>
-    Plugin? GetPlugin(string name);
+    IPlugin? GetPlugin(string name);
 
     /// <summary>
     ///     Loads a plugin with a specified name.
     /// </summary>
     /// <param name="name">The name of the plugin to load, sans the <c>.dll</c> extension.</param>
-    /// <returns>The newly loaded <see cref="Plugin" />.</returns>
+    /// <returns>The newly loaded plugin.</returns>
     /// <exception cref="ArgumentNullException">
     ///     <paramref name="name" /> is <see langword="null" />, empty, or consists of only whitespace characters.
     /// </exception>
     /// <exception cref="PluginNotFoundException">No plugin by the name <paramref name="name" /> could be found.</exception>
     /// <exception cref="InvalidPluginException">
     ///     The plugin does not contain an embedded resource named <c>plugin.json</c>.
     /// </exception>
-    Plugin LoadPlugin(string name);
+    IPlugin LoadPlugin(string name);
 
     /// <summary>
     ///     Loads all plugins that this plugin manager can detect.
     /// </summary>
-    /// <returns>The read-only view of the loaded <see cref="Plugin" /> instances.</returns>
-    IReadOnlyList<Plugin> LoadPlugins();
+    /// <returns>The read-only view of the loaded <see cref="MonoPlugin" /> instances.</returns>
+    IReadOnlyList<IPlugin> LoadPlugins();
 
     /// <summary>
     ///     Unloads a plugin.
     /// </summary>
     /// <param name="plugin">The plugin to unload.</param>
     /// <exception cref="ArgumentNullException"><paramref name="plugin" /> is <see langword="null" />.</exception>
     /// <exception cref="PluginNotLoadedException"><paramref name="plugin" /> refers to a plugin that is not loaded.</exception>
-    void UnloadPlugin(Plugin plugin);
+    void UnloadPlugin(IPlugin plugin);
 }

BrackeysBot.API/Plugins/Plugin.cs BrackeysBot.API/Plugins/MonoPlugin.csBrackeysBot.API/Plugins/Plugin.cs renamed to BrackeysBot.API/Plugins/MonoPlugin.cs

@@ -11,47 +11,32 @@ namespace BrackeysBot.API.Plugins;
 /// <summary>
 ///     Represents a bot plugin.
 /// </summary>
-public abstract class Plugin : IDisposable, IConfigurationHolder
+public abstract class MonoPlugin : IPlugin
 {
-    /// <summary>
-    ///     Gets the data directory for this plugin.
-    /// </summary>
-    /// <value>The data directory.</value>
+    /// <inheritdoc />
+    public IConfiguration Configuration { get; internal set; } = null!;
+
+    /// <inheritdoc />
     public DirectoryInfo DataDirectory { get; internal set; } = null!;
 
-    /// <summary>
-    ///     Gets the logger for this plugin.
-    /// </summary>
-    /// <value>The plugin's logger.</value>
+    /// <inheritdoc />
     public ILogger Logger { get; internal set; } = null!;
 
-    /// <summary>
-    ///     Gets the information about this plugin.
-    /// </summary>
-    /// <value>A <see cref="BrackeysBot.API.Plugins.PluginInfo" /> object containing</value>
+    /// <inheritdoc />
     public PluginInfo PluginInfo { get; internal set; } = null!;
 
-    /// <summary>
-    ///     Gets the manager which owns this plugin.
-    /// </summary>
-    /// <value>The plugin manager.</value>
+    /// <inheritdoc />
     public IPluginManager PluginManager { get; internal set; } = null!;
 
+    /// <inheritdoc />
+    public IServiceProvider ServiceProvider { get; internal set; } = null!;
+
     /// <summary>
     ///     Gets the underlying <see cref="DisCatSharp.DiscordClient" /> instance.
     /// </summary>
     /// <value>The underlying <see cref="DisCatSharp.DiscordClient" />.</value>
     protected internal DiscordClient? DiscordClient { get; internal set; }
 
-    /// <summary>
-    ///     Gets the service provider for this plugin.
-    /// </summary>
-    /// <value>The service provider.</value>
-    public IServiceProvider ServiceProvider { get; internal set; } = null!;
-
-    /// <inheritdoc />
-    public IConfiguration Configuration { get; internal set; } = null!;
-
     /// <inheritdoc />
     public virtual void Dispose()
     {

BrackeysBot.API/Plugins/PluginAttribute.cs

@@ -3,7 +3,7 @@
 namespace BrackeysBot.API.Plugins;
 
 /// <summary>
-///     Specifies <see cref="Plugin" /> information such as the plugin's name and version.
+///     Specifies <see cref="MonoPlugin" /> information such as the plugin's name and version.
 /// </summary>
 [AttributeUsage(AttributeTargets.Class)]
 public sealed class PluginAttribute : Attribute

BrackeysBot.API/Plugins/PluginAuthorAttribute.cs

@@ -3,7 +3,7 @@
 namespace BrackeysBot.API.Plugins;
 
 /// <summary>
-///     Specifies the author of a <see cref="Plugin" />.
+///     Specifies the author of a <see cref="MonoPlugin" />.
 /// </summary>
 [AttributeUsage(AttributeTargets.Class)]
 public sealed class PluginAuthorAttribute : Attribute

BrackeysBot.API/Plugins/PluginDependenciesAttribute.cs

@@ -3,7 +3,7 @@
 namespace BrackeysBot.API.Plugins;
 
 /// <summary>
-///     Specifies the dependencies that should be loaded prior to this <see cref="Plugin" />, so that this plugin functions
+///     Specifies the dependencies that should be loaded prior to this <see cref="MonoPlugin" />, so that this plugin functions
 ///     correctly.
 /// </summary>
 [AttributeUsage(AttributeTargets.Class)]

BrackeysBot.API/Plugins/PluginDescriptionAttribute.cs

@@ -3,7 +3,7 @@
 namespace BrackeysBot.API.Plugins;
 
 /// <summary>
-///     Specifies the description of a <see cref="Plugin" />.
+///     Specifies the description of a <see cref="MonoPlugin" />.
 /// </summary>
 [AttributeUsage(AttributeTargets.Class)]
 public sealed class PluginDescriptionAttribute : Attribute

BrackeysBot/BrackeysBotApp.cs

@@ -48,7 +48,7 @@ public BrackeysBotApp()
     /// </summary>
     public void DisablePlugins()
     {
-        foreach (Plugin plugin in PluginManager.EnabledPlugins)
+        foreach (IPlugin plugin in PluginManager.EnabledPlugins)
             PluginManager.DisablePlugin(plugin);
     }
 
@@ -57,7 +57,7 @@ public void DisablePlugins()
     /// </summary>
     public void EnablePlugins()
     {
-        foreach (Plugin plugin in PluginManager.LoadedPlugins)
+        foreach (IPlugin plugin in PluginManager.LoadedPlugins)
             PluginManager.EnablePlugin(plugin);
     }
 
@@ -107,7 +107,9 @@ protected override Task ExecuteAsync(CancellationToken stoppingToken)
     public override Task StopAsync(CancellationToken cancellationToken)
     {
         DisablePlugins();
-        foreach (Plugin plugin in PluginManager.LoadedPlugins) PluginManager.UnloadPlugin(plugin);
+
+        foreach (IPlugin plugin in PluginManager.LoadedPlugins)
+            PluginManager.UnloadPlugin(plugin);
 
         return base.StopAsync(cancellationToken);
     }