Optimize thread inclusion UX across GUI and CLI

Related to Tyrrrz#1119
nulldg · Aug 28, 2023 · 3740d64 · 3740d64
1 parent d430f77
commit 3740d64
Show file tree

Hide file tree

Showing 9 changed files with 49 additions and 79 deletions.
diff --git a/DiscordChatExporter.Cli/Commands/ExportAllCommand.cs b/DiscordChatExporter.Cli/Commands/ExportAllCommand.cs
@@ -29,15 +29,11 @@ public class ExportAllCommand : ExportCommandBase
 
     [CommandOption(
         "include-threads",
-        Description = "Specifies which types of threads should be included.",
+        Description = "Which types of threads should be included.",
         Converter = typeof(ThreadInclusionBindingConverter)
     )]
     public ThreadInclusion ThreadInclusion { get; init; } = ThreadInclusion.None;
 
-    private bool IncludeThreads => ThreadInclusion != ThreadInclusion.None;
-
-    private bool IncludeArchivedThreads => ThreadInclusion.HasFlag(ThreadInclusion.Archived);
-
     [CommandOption(
         "data-package",
         Description = "Path to the personal data package (ZIP file) requested from Discord. "
@@ -74,12 +70,12 @@ var channel in Discord.GetGuildChannelsAsync(guild.Id, cancellationToken)
                 }
 
                 // Threads
-                if (IncludeThreads)
+                if (ThreadInclusion != ThreadInclusion.None)
                 {
                     await foreach (
                         var thread in Discord.GetGuildThreadsAsync(
                             guild.Id,
-                            IncludeArchivedThreads,
+                            ThreadInclusion == ThreadInclusion.All,
                             cancellationToken
                         )
                     )
@@ -136,9 +132,9 @@ await console.Error.WriteLineAsync(
             channels.RemoveAll(c => c.Kind.IsGuild());
         if (!IncludeVoiceChannels)
             channels.RemoveAll(c => c.Kind.IsVoice());
-        if (!IncludeThreads)
+        if (ThreadInclusion == ThreadInclusion.None)
             channels.RemoveAll(c => c.Kind.IsThread());
-        if (!IncludeArchivedThreads)
+        if (ThreadInclusion != ThreadInclusion.All)
             channels.RemoveAll(c => c.Kind.IsThread() && c.IsArchived);
 
         await ExportAsync(console, channels);

diff --git a/DiscordChatExporter.Cli/Commands/ExportGuildCommand.cs b/DiscordChatExporter.Cli/Commands/ExportGuildCommand.cs
@@ -21,15 +21,11 @@ public class ExportGuildCommand : ExportCommandBase
 
     [CommandOption(
         "include-threads",
-        Description = "Specifies which types of threads should be included.",
+        Description = "Which types of threads should be included.",
         Converter = typeof(ThreadInclusionBindingConverter)
     )]
     public ThreadInclusion ThreadInclusion { get; init; } = ThreadInclusion.None;
 
-    private bool IncludeThreads => ThreadInclusion != ThreadInclusion.None;
-
-    private bool IncludeArchivedThreads => ThreadInclusion.HasFlag(ThreadInclusion.Archived);
-
     public override async ValueTask ExecuteAsync(IConsole console)
     {
         await base.ExecuteAsync(console);
@@ -52,12 +48,12 @@ public override async ValueTask ExecuteAsync(IConsole console)
         }
 
         // Threads
-        if (IncludeThreads)
+        if (ThreadInclusion != ThreadInclusion.None)
         {
             await foreach (
                 var thread in Discord.GetGuildThreadsAsync(
                     GuildId,
-                    IncludeArchivedThreads,
+                    ThreadInclusion == ThreadInclusion.All,
                     cancellationToken
                 )
             )

diff --git a/DiscordChatExporter.Cli/Commands/GetChannelsCommand.cs b/DiscordChatExporter.Cli/Commands/GetChannelsCommand.cs
@@ -23,15 +23,11 @@ public class GetChannelsCommand : DiscordCommandBase
 
     [CommandOption(
         "include-threads",
-        Description = "Specifies which types of threads should be included.",
+        Description = "Which types of threads should be included.",
         Converter = typeof(ThreadInclusionBindingConverter)
     )]
     public ThreadInclusion ThreadInclusion { get; init; } = ThreadInclusion.None;
 
-    private bool IncludeThreads => ThreadInclusion != ThreadInclusion.None;
-
-    private bool IncludeArchivedThreads => ThreadInclusion.HasFlag(ThreadInclusion.Archived);
-
     public override async ValueTask ExecuteAsync(IConsole console)
     {
         await base.ExecuteAsync(console);
@@ -50,17 +46,18 @@ public override async ValueTask ExecuteAsync(IConsole console)
             .OrderDescending()
             .FirstOrDefault();
 
-        var threads = IncludeThreads
-            ? (
-                await Discord.GetGuildThreadsAsync(
-                    GuildId,
-                    IncludeArchivedThreads,
-                    cancellationToken
+        var threads =
+            ThreadInclusion != ThreadInclusion.None
+                ? (
+                    await Discord.GetGuildThreadsAsync(
+                        GuildId,
+                        ThreadInclusion == ThreadInclusion.All,
+                        cancellationToken
+                    )
                 )
-            )
-                .OrderBy(c => c.Name)
-                .ToArray()
-            : Array.Empty<Channel>();
+                    .OrderBy(c => c.Name)
+                    .ToArray()
+                : Array.Empty<Channel>();
 
         foreach (var channel in channels)
         {

diff --git a/DiscordChatExporter.Cli/Commands/Shared/ThreadInclusion.cs b/DiscordChatExporter.Cli/Commands/Shared/ThreadInclusion.cs
@@ -1,12 +1,8 @@
-using System;
+namespace DiscordChatExporter.Cli.Commands.Shared;
 
-namespace DiscordChatExporter.Cli.Commands.Shared;
-
-[Flags]
 public enum ThreadInclusion
 {
-    None = 0,
-    Active = 1,
-    Archived = 2,
-    All = Active | Archived
+    None,
+    Active,
+    All
 }
diff --git a/DiscordChatExporter.Gui/Models/ThreadInclusion.cs b/DiscordChatExporter.Gui/Models/ThreadInclusion.cs
@@ -0,0 +1,8 @@
+namespace DiscordChatExporter.Gui.Models;
+
+public enum ThreadInclusion
+{
+    None,
+    Active,
+    All
+}
diff --git a/DiscordChatExporter.Gui/Services/SettingsService.cs b/DiscordChatExporter.Gui/Services/SettingsService.cs
@@ -2,6 +2,7 @@
 using System.IO;
 using Cogwheel;
 using DiscordChatExporter.Core.Exporting;
+using DiscordChatExporter.Gui.Models;
 using Microsoft.Win32;
 
 namespace DiscordChatExporter.Gui.Services;
@@ -16,9 +17,7 @@ public partial class SettingsService : SettingsBase
 
     public bool IsTokenPersisted { get; set; } = true;
 
-    public bool ShouldShowThreads { get; set; }
-
-    public bool ShouldShowArchivedThreads { get; set; }
+    public ThreadInclusion ThreadInclusion { get; set; } = ThreadInclusion.None;
 
     public string DateFormat { get; set; } = "MM/dd/yyyy h:mm tt";
 

diff --git a/DiscordChatExporter.Gui/ViewModels/Components/DashboardViewModel.cs b/DiscordChatExporter.Gui/ViewModels/Components/DashboardViewModel.cs
@@ -8,6 +8,7 @@
 using DiscordChatExporter.Core.Exceptions;
 using DiscordChatExporter.Core.Exporting;
 using DiscordChatExporter.Core.Utils.Extensions;
+using DiscordChatExporter.Gui.Models;
 using DiscordChatExporter.Gui.Services;
 using DiscordChatExporter.Gui.Utils;
 using DiscordChatExporter.Gui.ViewModels.Dialogs;
@@ -169,12 +170,12 @@ public async ValueTask PullChannelsAsync()
             }
 
             // Threads
-            if (_settingsService.ShouldShowThreads)
+            if (_settingsService.ThreadInclusion != ThreadInclusion.None)
             {
                 await foreach (
                     var thread in _discord.GetGuildThreadsAsync(
                         SelectedGuild.Id,
-                        _settingsService.ShouldShowArchivedThreads
+                        _settingsService.ThreadInclusion == ThreadInclusion.All
                     )
                 )
                 {

diff --git a/DiscordChatExporter.Gui/ViewModels/Dialogs/SettingsViewModel.cs b/DiscordChatExporter.Gui/ViewModels/Dialogs/SettingsViewModel.cs
@@ -1,4 +1,6 @@
 using System;
+using System.Collections.Generic;
+using DiscordChatExporter.Gui.Models;
 using DiscordChatExporter.Gui.Services;
 using DiscordChatExporter.Gui.ViewModels.Framework;
 
@@ -26,23 +28,13 @@ public bool IsTokenPersisted
         set => _settingsService.IsTokenPersisted = value;
     }
 
-    public bool ShouldShowThreads
-    {
-        get => _settingsService.ShouldShowThreads;
-        set => _settingsService.ShouldShowThreads = value;
-    }
+    public IReadOnlyList<ThreadInclusion> AvailableThreadInclusions { get; } =
+        Enum.GetValues<ThreadInclusion>();
 
-    public bool ShouldShowArchivedThreads
+    public ThreadInclusion ThreadInclusion
     {
-        get => _settingsService.ShouldShowArchivedThreads;
-        set
-        {
-            _settingsService.ShouldShowArchivedThreads = value;
-
-            // Enabling archived threads implicitly enables threads
-            if (value)
-                ShouldShowThreads = true;
-        }
+        get => _settingsService.ThreadInclusion;
+        set => _settingsService.ThreadInclusion = value;
     }
 
     public string DateFormat

diff --git a/DiscordChatExporter.Gui/Views/Dialogs/SettingsView.xaml b/DiscordChatExporter.Gui/Views/Dialogs/SettingsView.xaml
@@ -82,36 +82,21 @@
                             IsChecked="{Binding IsTokenPersisted}" />
                     </DockPanel>
 
-                    <!--  Show threads  -->
+                    <!--  Thread inclusion  -->
                     <DockPanel
                         Margin="16,8"
                         Background="Transparent"
                         LastChildFill="False"
-                        ToolTip="Pull threads and show them in the channel list">
+                        ToolTip="Which types of threads to show in the channel list">
                         <TextBlock
                             VerticalAlignment="Center"
                             DockPanel.Dock="Left"
                             Text="Show threads" />
-                        <ToggleButton
-                            VerticalAlignment="Center"
-                            DockPanel.Dock="Right"
-                            IsChecked="{Binding ShouldShowThreads}" />
-                    </DockPanel>
-
-                    <!--  Show archived threads  -->
-                    <DockPanel
-                        Margin="16,8"
-                        Background="Transparent"
-                        LastChildFill="False"
-                        ToolTip="Pull archived threads and show them in the channel list">
-                        <TextBlock
-                            VerticalAlignment="Center"
-                            DockPanel.Dock="Left"
-                            Text="Show archived threads" />
-                        <ToggleButton
+                        <ComboBox
                             VerticalAlignment="Center"
                             DockPanel.Dock="Right"
-                            IsChecked="{Binding ShouldShowArchivedThreads}" />
+                            ItemsSource="{Binding AvailableThreadInclusions}"
+                            SelectedItem="{Binding ThreadInclusion}" />
                     </DockPanel>
 
                     <!--  Date format  -->