fix tests and more comments

EvoEsports · Dec 6, 2023 · ea17bc1 · ea17bc1
1 parent d080544
commit ea17bc1
Show file tree

Hide file tree

Showing 5 changed files with 64 additions and 50 deletions.
diff --git a/src/EvoSC.Manialinks/Util/FontManialinkHelper.cs b/src/EvoSC.Manialinks/Util/FontManialinkHelper.cs
@@ -6,17 +6,42 @@ public class FontManialinkHelper
 {
     private readonly dynamic _theme;
 
+    /// <summary>
+    /// Thin thickness of the current font.
+    /// </summary>
     public string Thin => ToThin(_theme.UI_Font);
+
+    /// <summary>
+    /// Regular thickness of the current font.
+    /// </summary>
     public string Regular => ToRegular(_theme.UI_Font);
+
+    /// <summary>
+    /// Bold thickness of the current font.
+    /// </summary>
     public string Bold => ToBold(_theme.UI_Font);
+
+    /// <summary>
+    /// Extra bold thickness of the current font.
+    /// </summary>
     public string ExtraBold => ToExtraBold(_theme.UI_Font);
+
+    /// <summary>
+    /// Mono version of the current font.
+    /// </summary>
     public string Mono => ToExtraBold(_theme.UI_Font);
 
     public FontManialinkHelper(IThemeManager theme)
     {
         _theme = theme.Theme;
     }
 
+    /// <summary>
+    /// Convert the provided font to it's regular thickness version.
+    /// </summary>
+    /// <param name="font">Font to convert.</param>
+    /// <returns></returns>
+    /// <exception cref="InvalidOperationException"></exception>
     public string ToRegular(string font) => font switch
     {
         _ when font.StartsWith("GameFont") => "GameFontSemiBold",
@@ -26,25 +51,49 @@ _ when font.StartsWith("Roboto") => "RobotoCondensed",
         _ => throw new InvalidOperationException("Invalid font.")
     };
 
+    /// <summary>
+    /// Convert the provided font to it's thin thickness version.
+    /// </summary>
+    /// <param name="font">Font to convert.</param>
+    /// <returns></returns>
+    /// <exception cref="InvalidOperationException"></exception>
     public string ToThin(string font) => font switch
     {
         _ when font.StartsWith("GameFont") => "GameFontSemiRegular",
         _ => ToRegular(font)
     };
 
+    /// <summary>
+    /// Convert the provided font to it's bold thickness version.
+    /// </summary>
+    /// <param name="font">Font to convert.</param>
+    /// <returns></returns>
+    /// <exception cref="InvalidOperationException"></exception>
     public string ToBold(string font) => font switch
     {
         _ when font.StartsWith("GameFont") => "GameFontExtraBold",
         _ when font.StartsWith("Roboto") => "RobotoCondensedBold",
         _ => ToRegular(font)
     };
 
+    /// <summary>
+    /// Convert the provided font to it's extra bold thickness version.
+    /// </summary>
+    /// <param name="font">Font to convert.</param>
+    /// <returns></returns>
+    /// <exception cref="InvalidOperationException"></exception>
     public string ToExtraBold(string font) => font switch
     {
         _ when font.StartsWith("GameFont") => "GameFontBlack",
         _ => ToBold(font)
     };
-
+
+    /// <summary>
+    /// Convert the provided font to it's mono version.
+    /// </summary>
+    /// <param name="font">Font to convert.</param>
+    /// <returns></returns>
+    /// <exception cref="InvalidOperationException"></exception>
     public string ToMono(string font) => font switch
     {
         _ when font.StartsWith("Rajdhani") => "RajdhaniMono",

diff --git a/src/EvoSC.Manialinks/Util/GlobalManialinkUtils.cs b/src/EvoSC.Manialinks/Util/GlobalManialinkUtils.cs
@@ -12,6 +12,11 @@ public GlobalManialinkUtils(IThemeManager themeManager)
         _theme = themeManager.Theme;
     }
 
+    /// <summary>
+    /// Status type to a color.
+    /// </summary>
+    /// <param name="type">Name of the status.</param>
+    /// <returns></returns>
     public string TypeToColorBg(string type) => type.ToLower() switch
     {
         "info" => _theme.Teal,
@@ -23,6 +28,11 @@ public GlobalManialinkUtils(IThemeManager themeManager)
         _ => _theme.UI_BgPrimary
     };
 
+    /// <summary>
+    /// Status type to an icon.
+    /// </summary>
+    /// <param name="type">Name of the status.</param>
+    /// <returns></returns>
     public string TypeToIcon(string type) => type.ToLower() switch
     {
         "info" => _icons.InfoCircle,

diff --git a/tests/EvoSC.Common.Tests/Themes/ThemeManagerTests.cs b/tests/EvoSC.Common.Tests/Themes/ThemeManagerTests.cs
@@ -151,7 +151,7 @@ public async Task Available_Themes_Property_Returns_All_Themes()
         var themes = mock.ThemeManager.AvailableThemes.Select(t => t.Name).ToArray();
 
         Assert.NotEmpty(themes);
-        Assert.Equal(new[]{"Default", "MyTheme", "MyTheme2", "MyTheme3"}, themes);
+        Assert.Equal(new[]{"MyTheme", "MyTheme2", "MyTheme3"}, themes);
         Assert.Equal("MyThemeOptionValue", mock.ThemeManager.Theme.MyThemeOption);
         Assert.Equal("MyThemeOptionValue2", mock.ThemeManager.Theme.MyThemeOption2);
         Assert.Equal("MyThemeOptionValue3", mock.ThemeManager.Theme.MyThemeOption3);

diff --git a/tests/Modules/FastestCp.Tests/FastestCpManialinkTest.cs b/tests/Modules/FastestCp.Tests/FastestCpManialinkTest.cs
diff --git a/tests/Modules/FastestCp.Tests/FastestCpServiceTest.cs b/tests/Modules/FastestCp.Tests/FastestCpServiceTest.cs
@@ -56,7 +56,7 @@ await _fastestCpService.RegisterCpTimeAsync(new WayPointEventArgs
 
         var actualData = new List<object>();
         _manialinkManagerMock.Verify(
-            manager => manager.SendPersistentManialinkAsync("FastestCpModule.FastestCpModule", Capture.In(actualData)), Times.Once);
+            manager => manager.SendPersistentManialinkAsync("FastestCpModule.FastestCp", Capture.In(actualData)), Times.Once);
         Assert.NotEmpty(actualData);
         Assert.Equivalent(
             new { times = new List<PlayerCpTime?> { new("NickName1", 0, TimeSpan.FromMilliseconds(10)) } },
@@ -87,7 +87,7 @@ await _fastestCpService.RegisterCpTimeAsync(new WayPointEventArgs
         });
 
         _manialinkManagerMock.Verify(
-            manager => manager.SendPersistentManialinkAsync("FastestCpModule.FastestCpModule", It.IsAny<object>()), Times.Never);
+            manager => manager.SendPersistentManialinkAsync("FastestCpModule.FastestCp", It.IsAny<object>()), Times.Never);
     }
 
     [Fact]
@@ -102,7 +102,7 @@ public async void Should_Reset_Store()
         var after = fieldInfo?.GetValue(_fastestCpService);
 
 
-        _manialinkManagerMock.Verify(manager => manager.HideManialinkAsync("FastestCpModule.FastestCpModule"), Times.Once);
+        _manialinkManagerMock.Verify(manager => manager.HideManialinkAsync("FastestCpModule.FastestCp"), Times.Once);
 
         Assert.NotNull(before);
         Assert.NotNull(after);