Code comments

Author: ProgrammingByPermutation

src/Nullinside.Api.TwitchBot.Tests/ChatRules/AChatRuleUnitTestBase.cs

@@ -5,10 +5,14 @@
 
 namespace Nullinside.Api.TwitchBot.Tests.ChatRules;
 
+/// <summary>
+///     A generic set of sets that all chat rules should be put through.
+/// </summary>
+/// <typeparam name="T"></typeparam>
 public abstract class AChatRuleUnitTestBase<T> : UnitTestBase where T : AChatRule, new()
 {
     /// <summary>
-    /// Tests that the message filter is capable of passing at all.
+    ///     Tests that the message filter is capable of passing at all.
     /// </summary>
     /// <param name="goodString">A friendly string with no issues.</param>
     [Test]
@@ -17,38 +21,38 @@ public async Task TestItDoesntAlwaysFail(string goodString)
     {
         var rule = new T();
         var botProxy = new Mock<ITwitchApiProxy>();
-        
+
         // Process the message and assert that we pass the message.
         var chat = new TwitchChatMessage(true, goodString, "123", "456");
-        var result = await rule.Handle("123", botProxy.Object, chat, this._db);
+        var result = await rule.Handle("123", botProxy.Object, chat, _db);
         Assert.That(result, Is.True);
-        
+
         // Process the message and assert that we pass the message.
         chat = new TwitchChatMessage(false, goodString, "123", "456");
-        result = await rule.Handle("123", botProxy.Object, chat, this._db);
+        result = await rule.Handle("123", botProxy.Object, chat, _db);
         Assert.That(result, Is.True);
     }
-    
+
     /// <summary>
-    /// Tests that the rules are only running when they should be.
+    ///     Tests that the rules are only running when they should be.
     /// </summary>
     [Test]
     public void TestShouldRun()
     {
         var rule = new T();
-        
+
         // Rule is turned on and so is scanning.
         var shouldRun = rule.ShouldRun(new TwitchUserConfig { Enabled = true, BanKnownBots = true });
         Assert.That(shouldRun, Is.True);
-        
+
         // Scanning is turned off
         shouldRun = rule.ShouldRun(new TwitchUserConfig { Enabled = false, BanKnownBots = true });
         Assert.That(shouldRun, Is.False);
-        
+
         // Rule is turned off.
         shouldRun = rule.ShouldRun(new TwitchUserConfig { Enabled = true, BanKnownBots = false });
         Assert.That(shouldRun, Is.False);
-        
+
         // Everything is off.
         shouldRun = rule.ShouldRun(new TwitchUserConfig { Enabled = false, BanKnownBots = false });
         Assert.That(shouldRun, Is.False);

src/Nullinside.Api.TwitchBot.Tests/ChatRules/BestCheapViewersTests.cs

@@ -1,12 +1,18 @@
 using Moq;
 using Nullinside.Api.Common.Twitch;
-using Nullinside.Api.Model;
 using Nullinside.Api.TwitchBot.ChatRules;
-using TwitchLib.Client.Models;
 
 namespace Nullinside.Api.TwitchBot.Tests.ChatRules;
 
-public class BestCheapViewersTests : AChatRuleUnitTestBase<BestCheapViewers> {
+/// <summary>
+///     Tests the <see cref="BestCheapViewers" /> class.
+/// </summary>
+public class BestCheapViewersTests : AChatRuleUnitTestBase<BestCheapViewers>
+{
+    /// <summary>
+    ///     Tests strings that have been typed in chats.
+    /// </summary>
+    /// <param name="badString">The string that should fail.</param>
     [Test]
     [TestCase("Best viewers on ***")]
     [TestCase("Best  viewers on ***")]
@@ -28,9 +34,9 @@ public async Task TestKnownStrings(string badString)
         var rule = new BestCheapViewers();
         var botProxy = new Mock<ITwitchApiProxy>();
         var chat = new TwitchChatMessage(true, badString, "123", "456");
-        
+
         // Process the message and assert that we fail the message.
-        var result = await rule.Handle("123", botProxy.Object, chat, this._db);
+        var result = await rule.Handle("123", botProxy.Object, chat, _db);
         Assert.That(result, Is.False);
     }
 }

src/Nullinside.Api.TwitchBot.Tests/ChatRules/DiscordTests.cs

@@ -4,36 +4,52 @@
 
 namespace Nullinside.Api.TwitchBot.Tests.ChatRules;
 
+/// <summary>
+///     Tests the <see cref="Discord" /> class.
+/// </summary>
 public class DiscordTests : AChatRuleUnitTestBase<Discord>
 {
+    /// <summary>
+    ///     Tests the strings typed in chats.
+    /// </summary>
+    /// <param name="badString">The string that should fail.</param>
     [Test]
-    [TestCase("Hello mate you stream pretty cool that's why I follow I would love to be a fan of yours if you don't mind kindly add me on Discord: 👉👉lacaster5")]
-    [TestCase("Hello, I just recently found your channel and can already tell that your content is great, and I would love to stick with you long term. If you're open to it, I'd be willing to connect with you on Discord. My username is teecash1000")]
-    [TestCase("Hey there 👋 You stream pretty cool that’s why I followed you. I will like to make you a friend and be a fan, if you don’t mind Kindly chat me on Discord, my Discord username is tuckzay")]
-    [TestCase("Hi! Just wanted to say that I absolutely love your gameplay and content.l'd love to connect better with you on Discord if that's possible. Looking forward to more awesome streams from you! My username is 👉👉👉 edisonpires")]
-    [TestCase("What's up Friend, great stream! I'm having a blast watching you stream. Let's move the conversation to Discord, where we can discuss more about streaming in more detail and get to know each other better. See you there! My discord username is 👉john_6029")]
+    [TestCase(
+        "Hello mate you stream pretty cool that's why I follow I would love to be a fan of yours if you don't mind kindly add me on Discord: 👉👉lacaster5")]
+    [TestCase(
+        "Hello, I just recently found your channel and can already tell that your content is great, and I would love to stick with you long term. If you're open to it, I'd be willing to connect with you on Discord. My username is teecash1000")]
+    [TestCase(
+        "Hey there 👋 You stream pretty cool that’s why I followed you. I will like to make you a friend and be a fan, if you don’t mind Kindly chat me on Discord, my Discord username is tuckzay")]
+    [TestCase(
+        "Hi! Just wanted to say that I absolutely love your gameplay and content.l'd love to connect better with you on Discord if that's possible. Looking forward to more awesome streams from you! My username is 👉👉👉 edisonpires")]
+    [TestCase(
+        "What's up Friend, great stream! I'm having a blast watching you stream. Let's move the conversation to Discord, where we can discuss more about streaming in more detail and get to know each other better. See you there! My discord username is 👉john_6029")]
     public async Task TestKnownStrings(string badString)
     {
         var rule = new Discord();
         var botProxy = new Mock<ITwitchApiProxy>();
         var chat = new TwitchChatMessage(true, badString, "123", "456");
-        
+
         // Process the message and assert that we fail the message.
-        var result = await rule.Handle("123", botProxy.Object, chat, this._db);
+        var result = await rule.Handle("123", botProxy.Object, chat, _db);
         Assert.That(result, Is.False);
     }
-    
+
+    /// <summary>
+    ///     Ensure that the rule doesn't fail just because it contains the word discord.
+    /// </summary>
+    /// <param name="message">The message.</param>
     [Test]
     [TestCase("I've heard of the application discord before and it sounds great")]
     [TestCase("I was talking on my discord the other day")]
-    public async Task EnsureNoFalsePositives(string badString)
+    public async Task EnsureNoFalsePositives(string message)
     {
         var rule = new Discord();
         var botProxy = new Mock<ITwitchApiProxy>();
-        var chat = new TwitchChatMessage(true, badString, "123", "456");
-        
+        var chat = new TwitchChatMessage(true, message, "123", "456");
+
         // Process the message and assert that we do not fail the message.
-        var result = await rule.Handle("123", botProxy.Object, chat, this._db);
+        var result = await rule.Handle("123", botProxy.Object, chat, _db);
         Assert.That(result, Is.True);
     }
 }

src/Nullinside.Api.TwitchBot.Tests/ChatRules/StreamViewersTests.cs

@@ -4,19 +4,28 @@
 
 namespace Nullinside.Api.TwitchBot.Tests.ChatRules;
 
+/// <summary>
+///     Tests the <see cref="StreamViewers" /> class.
+/// </summary>
 public class StreamViewersTests : AChatRuleUnitTestBase<StreamViewers>
 {
+    /// <summary>
+    ///     Tests the strings typed in chats.
+    /// </summary>
+    /// <param name="badString">The string that should fail.</param>
     [Test]
-    [TestCase("@jellynyeko dо уоu alrеady triеd strеamviewers  оrg? Real viewеrs, fire works! Тhеy arе now giving оut а frее рackagе for streamers оО")]
-    [TestCase("@kygaming98 dо уоu аlready tried streаmviewers  оrg? Real viewers, firе works! Thеy arе now giving оut а freе package fоr streamers oО")]
+    [TestCase(
+        "@jellynyeko dо уоu alrеady triеd strеamviewers  оrg? Real viewеrs, fire works! Тhеy arе now giving оut а frее рackagе for streamers оО")]
+    [TestCase(
+        "@kygaming98 dо уоu аlready tried streаmviewers  оrg? Real viewers, firе works! Thеy arе now giving оut а freе package fоr streamers oО")]
     public async Task TestKnownStrings(string badString)
     {
         var rule = new StreamViewers();
         var botProxy = new Mock<ITwitchApiProxy>();
         var chat = new TwitchChatMessage(true, badString, "123", "456");
-        
+
         // Process the message and assert that we fail the message.
-        var result = await rule.Handle("123", botProxy.Object, chat, this._db);
+        var result = await rule.Handle("123", botProxy.Object, chat, _db);
         Assert.That(result, Is.False);
     }
 }

src/Nullinside.Api.TwitchBot.Tests/Nullinside.Api.TwitchBot.Tests.csproj

@@ -11,26 +11,26 @@
 
     <ItemGroup>
         <PackageReference Include="coverlet.collector" Version="6.0.2">
-          <PrivateAssets>all</PrivateAssets>
-          <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
-        <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="8.0.8" />
-        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1" />
-        <PackageReference Include="Moq" Version="4.20.72" />
-        <PackageReference Include="NUnit" Version="4.2.2" />
+        <PackageReference Include="Microsoft.EntityFrameworkCore.InMemory" Version="8.0.8"/>
+        <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.11.1"/>
+        <PackageReference Include="Moq" Version="4.20.72"/>
+        <PackageReference Include="NUnit" Version="4.2.2"/>
         <PackageReference Include="NUnit.Analyzers" Version="4.3.0">
-          <PrivateAssets>all</PrivateAssets>
-          <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
         </PackageReference>
-        <PackageReference Include="NUnit3TestAdapter" Version="4.6.0" />
+        <PackageReference Include="NUnit3TestAdapter" Version="4.6.0"/>
     </ItemGroup>
 
     <ItemGroup>
         <Using Include="NUnit.Framework"/>
     </ItemGroup>
 
     <ItemGroup>
-      <ProjectReference Include="..\Nullinside.Api.TwitchBot\Nullinside.Api.TwitchBot.csproj" />
+        <ProjectReference Include="..\Nullinside.Api.TwitchBot\Nullinside.Api.TwitchBot.csproj"/>
     </ItemGroup>
 
 </Project>

src/Nullinside.Api.TwitchBot.Tests/UnitTestBase.cs

@@ -5,28 +5,31 @@
 namespace Nullinside.Api.TwitchBot.Tests;
 
 /// <summary>
-///   A base class for all unit tests.
+///     A base class for all unit tests.
 /// </summary>
-public abstract class UnitTestBase {
+public abstract class UnitTestBase
+{
   /// <summary>
-  ///   A fake database.
+  ///     A fake database.
   /// </summary>
   protected INullinsideContext _db;
 
-  [SetUp]
-  public virtual void Setup() {
-    // Create an in-memory database to fake the SQL queries. Note that we generate a random GUID for the name
-    // here. If you use the same name more than once you'll get collisions between tests.
-    DbContextOptions<NullinsideContext> contextOptions = new DbContextOptionsBuilder<NullinsideContext>()
-      .UseInMemoryDatabase(Guid.NewGuid().ToString())
-      .ConfigureWarnings(b => b.Ignore(InMemoryEventId.TransactionIgnoredWarning))
-      .Options;
-    _db = new NullinsideContext(contextOptions);
-  }
+    [SetUp]
+    public virtual void Setup()
+    {
+        // Create an in-memory database to fake the SQL queries. Note that we generate a random GUID for the name
+        // here. If you use the same name more than once you'll get collisions between tests.
+        var contextOptions = new DbContextOptionsBuilder<NullinsideContext>()
+            .UseInMemoryDatabase(Guid.NewGuid().ToString())
+            .ConfigureWarnings(b => b.Ignore(InMemoryEventId.TransactionIgnoredWarning))
+            .Options;
+        _db = new NullinsideContext(contextOptions);
+    }
 
-  [TearDown]
-  public virtual async Task TearDown() {
-    // Dispose since it has one.
-    await _db.DisposeAsync();
-  }
+    [TearDown]
+    public virtual async Task TearDown()
+    {
+        // Dispose since it has one.
+        await _db.DisposeAsync();
+    }
 }