chore: clean up code

This cleans up most of the design.

#52

Author: ProgrammingByPermutation

src/TwitchStreamingTools/App.axaml.cs

@@ -9,7 +9,6 @@
 
 using Nullinside.Api.Common.Twitch;
 
-using TwitchStreamingTools.Models;
 using TwitchStreamingTools.Services;
 using TwitchStreamingTools.ViewModels;
 using TwitchStreamingTools.Views;
@@ -52,6 +51,11 @@ public override void OnFrameworkInitializationCompleted() {
     base.OnFrameworkInitializationCompleted();
   }
 
+  /// <summary>
+  ///   The handler for the "show" button on the taskbar context menu.
+  /// </summary>
+  /// <param name="sender">The invoker.</param>
+  /// <param name="e">The event arguments.</param>
   private void ShowSettings_OnClick(object? sender, EventArgs e) {
     if (ApplicationLifetime is IClassicDesktopStyleApplicationLifetime desktop) {
       if (null == desktop.MainWindow) {
@@ -62,6 +66,11 @@ private void ShowSettings_OnClick(object? sender, EventArgs e) {
     }
   }
 
+  /// <summary>
+  ///   The handler for the "close" button on the taskbar context menu.
+  /// </summary>
+  /// <param name="sender">The invoker.</param>
+  /// <param name="e">The event arguments.</param>
   private void Close_OnClick(object? sender, EventArgs e) {
     Environment.Exit(0);
   }

src/TwitchStreamingTools/Models/Configuration.cs renamed to src/TwitchStreamingTools/Configuration.cs

@@ -1,12 +1,17 @@
 using System;
 using System.Collections.Generic;
 using System.IO;
+using System.Linq;
+using System.Speech.Synthesis;
 
 using Newtonsoft.Json;
 
 using Nullinside.Api.Common.Twitch;
 
-namespace TwitchStreamingTools.Models;
+using TwitchStreamingTools.Models;
+using TwitchStreamingTools.Utilities;
+
+namespace TwitchStreamingTools;
 
 /// <summary>
 ///   The configuration of the application.
@@ -16,6 +21,9 @@ public class Configuration {
     Path.Combine(Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData), "nullinside",
       "twitch-streaming-tools", "config.json");
 
+  /// <summary>
+  ///   The singleton instance.
+  /// </summary>
   private static Configuration? s_instance;
 
   /// <summary>
@@ -61,6 +69,31 @@ public static Configuration Instance {
   /// </summary>
   public IDictionary<string, string>? TtsPhoneticUsernames { get; set; }
 
+  /// <summary>
+  ///   Retrieves the default audio device configured in the application.
+  /// </summary>
+  /// <returns>The default audio device, if any audio device exists.</returns>
+  public static string? GetDefaultAudioDevice() {
+    return Instance.TwitchChats?.FirstOrDefault()?.OutputDevice ?? NAudioUtilities.GetDefaultOutputDevice();
+  }
+
+  /// <summary>
+  ///   Retrieves the default TTS voice configured in the application.
+  /// </summary>
+  /// <returns>The default tts voice, if any tts voice exists.</returns>
+  public static string? GetDefaultTtsVoice() {
+    using var speech = new SpeechSynthesizer();
+    return Instance.TwitchChats?.FirstOrDefault()?.TtsVoice ?? speech.GetInstalledVoices().FirstOrDefault()?.VoiceInfo.Name;
+  }
+
+  /// <summary>
+  ///   Retrieves the default TTS volume configured in the application.
+  /// </summary>
+  /// <returns>The default tts voice, if any tts voice exists.</returns>
+  public static uint? GetDefaultTtsVolume() {
+    return Instance.TwitchChats?.FirstOrDefault()?.TtsVolume;
+  }
+
   /// <summary>
   ///   Reads the configuration from disk.
   /// </summary>
@@ -89,34 +122,4 @@ public bool WriteConfiguration() {
       return false;
     }
   }
-
-  /// <summary>
-  ///   Represents a single connection to a twitch chat by a single user.
-  /// </summary>
-  public class TwitchChatConfiguration {
-    /// <summary>
-    ///   Gets or sets the output device to send audio to.
-    /// </summary>
-    public string? OutputDevice { get; set; }
-
-    /// <summary>
-    ///   Gets or sets a value indicating whether text to speech is on.
-    /// </summary>
-    public bool TtsOn { get; set; }
-
-    /// <summary>
-    ///   Gets or sets the selected Microsoft Text to Speech voice.
-    /// </summary>
-    public string? TtsVoice { get; set; }
-
-    /// <summary>
-    ///   Gets or sets the volume of the text to speech voice.
-    /// </summary>
-    public uint TtsVolume { get; set; }
-
-    /// <summary>
-    ///   Gets or sets the twitch channel to read chat from.
-    /// </summary>
-    public string? TwitchChannel { get; set; }
-  }
 }

src/TwitchStreamingTools/Constants.cs

@@ -42,7 +42,7 @@ public static class Constants {
   public const string TWITCH_CLIENT_REDIRECT = $"{API_SITE_DOMAIN}/api/v1/user/twitch-login/twitch-streaming-tools";
 
   /// <summary>
-  /// The version of the application being run right now.
+  ///   The version of the application being run right now.
   /// </summary>
   public static readonly string? APP_VERSION = Assembly.GetEntryAssembly()?.GetName().Version?.ToString()[..^2];
 

src/TwitchStreamingTools/Models/TwitchChatConfiguration.cs

@@ -0,0 +1,31 @@
+namespace TwitchStreamingTools.Models;
+
+/// <summary>
+///   The twitch chat TTS configuration
+/// </summary>
+public class TwitchChatConfiguration {
+  /// <summary>
+  ///   Gets or sets the output device to send audio to.
+  /// </summary>
+  public string? OutputDevice { get; set; }
+
+  /// <summary>
+  ///   Gets or sets a value indicating whether text to speech is on.
+  /// </summary>
+  public bool TtsOn { get; set; }
+
+  /// <summary>
+  ///   Gets or sets the selected Microsoft Text to Speech voice.
+  /// </summary>
+  public string? TtsVoice { get; set; }
+
+  /// <summary>
+  ///   Gets or sets the volume of the text to speech voice.
+  /// </summary>
+  public uint TtsVolume { get; set; }
+
+  /// <summary>
+  ///   Gets or sets the twitch channel to read chat from.
+  /// </summary>
+  public string? TwitchChannel { get; set; }
+}

src/TwitchStreamingTools/Program.cs

@@ -12,13 +12,23 @@ internal sealed class Program {
   // Initialization code. Don't use any Avalonia, third-party APIs or any
   // SynchronizationContext-reliant code before AppMain is called: things aren't initialized
   // yet and stuff might break.
+
+  /// <summary>
+  ///   Main entrypoint of the application.
+  /// </summary>
+  /// <param name="args">The arguments passed to the application.</param>
   [STAThread]
   public static void Main(string[] args) {
     BuildAvaloniaApp()
       .StartWithClassicDesktopLifetime(args);
   }
 
   // Avalonia configuration, don't remove; also used by visual designer.
+
+  /// <summary>
+  ///   Builds the avalonia application.
+  /// </summary>
+  /// <returns>The application builder.</returns>
   public static AppBuilder BuildAvaloniaApp() {
     return AppBuilder.Configure<App>()
       .UsePlatformDetect()

src/TwitchStreamingTools/Services/ServiceCollectionExtensions.cs renamed to src/TwitchStreamingTools/ServiceCollectionExtensions.cs

@@ -20,7 +20,7 @@ public static class ServiceCollectionExtensions {
   public static void AddCommonServices(this IServiceCollection collection) {
     collection.AddSingleton<ITwitchAccountService, TwitchAccountService>();
     collection.AddSingleton<ITwitchClientProxy, TwitchClientProxy>(_ => TwitchClientProxy.Instance);
-    collection.AddSingleton<TwitchTtsService>();
+    collection.AddSingleton<ITwitchTtsService, TwitchTtsService>();
 
     collection.AddTransient<MainWindowViewModel>();
     collection.AddTransient<AccountViewModel>();
@@ -35,6 +35,6 @@ public static void AddCommonServices(this IServiceCollection collection) {
   /// <param name="provider">The service provider.</param>
   public static void StartupServices(this IServiceProvider provider) {
     provider.GetRequiredService<ITwitchAccountService>();
-    provider.GetRequiredService<TwitchTtsService>();
+    provider.GetRequiredService<ITwitchTtsService>();
   }
 }

src/TwitchStreamingTools/Services/ITwitchAccountService.cs

@@ -6,11 +6,11 @@
 namespace TwitchStreamingTools.Services;
 
 /// <summary>
-///   The contract for management credentials in the application.
+///   The contract for credential management in the application.
 /// </summary>
 public interface ITwitchAccountService {
   /// <summary>
-  ///   The current OAuth's twitch username.
+  ///   The current oauth token's twitch username.
   /// </summary>
   string? TwitchUsername { get; set; }
 

src/TwitchStreamingTools/Services/ITwitchTtsService.cs

@@ -0,0 +1,7 @@
+namespace TwitchStreamingTools.Services;
+
+/// <summary>
+///   The contract for a service that handles TTS reading of twitch chat.
+/// </summary>
+public interface ITwitchTtsService {
+}

src/TwitchStreamingTools/Services/TwitchAccountService.cs

@@ -103,15 +103,21 @@ public void DeleteCredentials() {
   private async Task OnCheckCredentials() {
     _timer.Stop();
     try {
+      // Grab the value so we can check if the value changed
       bool previousValue = CredentialsAreValid;
 
+      // Refresh the token
       await DoTokenRefreshIfNearExpiration();
 
+      // Make sure the new token works
       var twitchApi = new TwitchApiWrapper();
       string? username = (await twitchApi.GetUser()).username;
+
+      // Update the credentials
       CredentialsAreValid = !string.IsNullOrWhiteSpace(username);
       TwitchUsername = username;
 
+      // Fire off the event if something changed
       if (previousValue != CredentialsAreValid) {
         OnCredentialsStatusChanged?.Invoke(CredentialsAreValid);
       }
@@ -129,6 +135,8 @@ private async Task OnCheckCredentials() {
   /// </summary>
   private async Task DoTokenRefreshIfNearExpiration() {
     var twitchApi = new TwitchApiWrapper();
+
+    // Don't wait until the token is expired, refresh it ~1 hour before it expires 
     DateTime expiration = twitchApi.OAuth?.ExpiresUtc ?? DateTime.MaxValue;
     TimeSpan timeUntil = expiration - (DateTime.UtcNow + TimeSpan.FromHours(1));
     if (timeUntil.Ticks >= 0) {
@@ -140,8 +148,10 @@ private async Task DoTokenRefreshIfNearExpiration() {
       return;
     }
 
+    // Refresh the token
     await twitchApi.RefreshAccessToken();
 
+    // Update the configuration
     Configuration.Instance.OAuth = new OAuthResponse {
       Bearer = twitchApi.OAuth.AccessToken,
       Refresh = twitchApi.OAuth.RefreshToken,