Split PageCursor out of VoicePaginator

Author: GnomedDev

Cargo.lock

@@ -28,11 +28,6 @@ workspace = true
 [dependencies]
 const_format = "0.2"
 jemallocator = "0.5.4"
-small-fixed-array = { version = "0.4.5", features = [
-    "nightly",
-    "to-arraystring",
-] }
-
 rand.workspace = true
 bytes.workspace = true
 serde.workspace = true
@@ -46,6 +41,7 @@ dashmap.workspace = true
 mini-moka.workspace = true
 parking_lot.workspace = true
 tokio-tungstenite.workspace = true
+small-fixed-array.workspace = true
 
 tts_core = { path = "tts_core" }
 tts_tasks = { path = "tts_tasks" }
@@ -68,6 +64,7 @@ parking_lot = "0.12"
 mini-moka = { version = "0.10.3", features = ["sync"] }
 serde_json = { version = "1.0.149", default-features = false }
 tokio-tungstenite = { version = "0.28.0", default-features = false }
+small-fixed-array = { version = "0.4.5", features = ["nightly", "to-arraystring"] }
 # TODO: Remove `dashmap` once mini_moka releases a breaking version with dashmap 6.
 typesize = { version = "0.1.9", features = ["arrayvec", "dashmap", "details"] }
 

Cargo.toml

@@ -29,7 +29,7 @@
             lockFile = ./Cargo.lock;
             outputHashes = {
               "poise-0.6.1" = "sha256-6NU1UOQUz8WO77Luv7VLp/RL1May65Y7JmMWxaPbgvo=";
-              "serenity-0.12.5" = "sha256-V5FxH5DlNqPE0Eb76y5zL6ZjzX4q52H2hspqaoOGeQA=";
+              "serenity-0.12.5" = "sha256-tonM8Ixc1dLRmNDjPX54gsyimMLWTiB0/LMHHfQtpNo=";
             };
           };
 
@@ -38,8 +38,10 @@
             mold
           ];
 
-          doCheck = false;
           hardeningDisable = [ "fortify" ];
+          checkPhase = ''
+            cargo test -p tts_commands
+          '';
         };
       in
       tts-utils.mkTTSModule {

flake.lock

@@ -21,6 +21,7 @@ serenity.workspace = true
 typesize.workspace = true
 arrayvec.workspace = true
 parking_lot.workspace = true
+small-fixed-array.workspace = true
 
 tts_core = { path = "../tts_core" }
 

flake.nix

@@ -2,7 +2,7 @@ mod owner;
 mod setup;
 mod voice_paginator;
 
-use std::{borrow::Cow, collections::HashMap, fmt::Write, sync::atomic::Ordering};
+use std::{borrow::Cow, collections::BTreeMap, fmt::Write, sync::atomic::Ordering};
 
 use aformat::{ToArrayString, aformat};
 use arrayvec::ArrayString;
@@ -1209,7 +1209,7 @@ async fn list_polly_voices(ctx: &Context<'_>) -> Result<(String, Box<[String]>)>
         _ => &data.polly_voices[TTSMode::Polly.default_voice()],
     };
 
-    let mut lang_to_voices: HashMap<_, Vec<_>> = HashMap::new();
+    let mut lang_to_voices: BTreeMap<_, Vec<_>> = BTreeMap::new();
     for voice in data.polly_voices.values() {
         lang_to_voices
             .entry(&voice.language_name)

tts_commands/Cargo.toml

@@ -0,0 +1,120 @@
+use std::num::Saturating;
+
+use tracing::warn;
+
+#[derive(Debug)]
+pub(super) struct PageCursor {
+    pages: Box<[String]>,
+    index: Saturating<usize>,
+}
+
+impl PageCursor {
+    pub fn new(pages: Box<[String]>) -> Self {
+        Self {
+            pages,
+            index: Saturating(0),
+        }
+    }
+
+    pub fn jump_start(&mut self) {
+        self.index = Saturating(0);
+    }
+
+    pub fn can_rewind(&self) -> bool {
+        self.index != Saturating(0)
+    }
+
+    pub fn rewind(&mut self) {
+        self.index -= 1;
+    }
+
+    pub fn current(&self) -> &str {
+        if let Some(page) = self.pages.get(self.index.0) {
+            page
+        } else {
+            warn!("Ran off the end of the pages: {self:?}");
+            ""
+        }
+    }
+
+    pub fn can_advance(&self) -> bool {
+        self.index != Saturating(self.pages.len() - 1)
+    }
+
+    pub fn advance(&mut self) {
+        self.index = (self.index + Saturating(1)).min(Saturating(self.pages.len() - 1));
+    }
+
+    pub fn jump_end(&mut self) {
+        self.index = Saturating(self.pages.len() - 1);
+    }
+}
+
+#[cfg(test)]
+mod tests {
+    use crate::settings::voice_paginator::PageCursor;
+
+    fn make_pages() -> PageCursor {
+        PageCursor::new(
+            ["a", "b", "c", "d", "e", "f"]
+                .into_iter()
+                .map(String::from)
+                .collect(),
+        )
+    }
+
+    #[test]
+    fn rewind_off_start() {
+        let mut cursor = make_pages();
+        for _ in 0..25 {
+            cursor.rewind();
+        }
+
+        assert_eq!(cursor.current(), "a");
+    }
+
+    #[test]
+    fn rewind_after_end() {
+        let mut cursor = make_pages();
+        assert!(!cursor.can_rewind());
+        assert_eq!(cursor.current(), "a");
+        for _ in 0..2 {
+            cursor.jump_start();
+            assert!(!cursor.can_rewind());
+            assert_eq!(cursor.current(), "a");
+        }
+        for _ in 0..2 {
+            cursor.rewind();
+            assert!(!cursor.can_rewind());
+            assert_eq!(cursor.current(), "a");
+        }
+    }
+
+    #[test]
+    fn advance_past_start() {
+        let mut cursor = make_pages();
+        for _ in 0..25 {
+            cursor.advance();
+        }
+
+        assert_eq!(cursor.current(), "f");
+    }
+
+    #[test]
+    fn advance_after_end() {
+        let mut cursor = make_pages();
+
+        assert!(cursor.can_advance());
+        assert_eq!(cursor.current(), "a");
+        for _ in 0..2 {
+            cursor.jump_end();
+            assert!(!cursor.can_advance());
+            assert_eq!(cursor.current(), "f");
+        }
+        for _ in 0..2 {
+            cursor.advance();
+            assert!(!cursor.can_advance());
+            assert_eq!(cursor.current(), "f");
+        }
+    }
+}

tts_commands/src/settings/mod.rs

@@ -5,11 +5,14 @@ use serenity::{CollectComponentInteractions, builder::*, small_fixed_array::Fixe
 
 use tts_core::structs::{Context, TTSMode};
 
+use cursor::PageCursor;
+
+mod cursor;
+
 pub struct MenuPaginator<'a> {
-    index: usize,
     mode: TTSMode,
     ctx: Context<'a>,
-    pages: Box<[String]>,
+    pages: PageCursor,
     footer: Cow<'a, str>,
     current_voice: String,
 }
@@ -24,11 +27,10 @@ impl<'a> MenuPaginator<'a> {
     ) -> Self {
         Self {
             ctx,
-            pages,
             current_voice,
             mode,
             footer,
-            index: 0,
+            pages: PageCursor::new(pages),
         }
     }
 
@@ -55,9 +57,8 @@ impl<'a> MenuPaginator<'a> {
                     ))
                     .disabled(
                         disabled
-                            || (["⏮️", "◀"].contains(&emoji) && self.index == 0)
-                            || (["▶️", "⏭️"].contains(&emoji)
-                                && self.index == (self.pages.len() - 1)),
+                            || (["⏮️", "◀"].contains(&emoji) && !self.pages.can_rewind())
+                            || (["▶️", "⏭️"].contains(&emoji) && !self.pages.can_advance()),
                     )
             })
             .collect();
@@ -68,7 +69,7 @@ impl<'a> MenuPaginator<'a> {
     async fn create_message(&self) -> serenity::Result<serenity::MessageId> {
         let components = [self.create_action_row(false)];
         let builder = poise::CreateReply::default()
-            .embed(self.create_page(&self.pages[self.index]))
+            .embed(self.create_page(self.pages.current()))
             .components(&components);
 
         self.ctx.send(builder).await?.message().await.map(|m| m.id)
@@ -81,7 +82,7 @@ impl<'a> MenuPaginator<'a> {
     ) -> serenity::Result<()> {
         let components = [self.create_action_row(disable)];
         let builder = CreateInteractionResponseMessage::default()
-            .embed(self.create_page(&self.pages[self.index]))
+            .embed(self.create_page(self.pages.current()))
             .components(&components);
 
         let response = CreateInteractionResponse::UpdateMessage(builder);
@@ -104,22 +105,22 @@ impl<'a> MenuPaginator<'a> {
 
             match interaction.data.custom_id.as_str() {
                 "⏮️" => {
-                    self.index = 0;
+                    self.pages.jump_start();
                     self.edit_message(interaction, false).await?;
                 }
                 "◀" => {
-                    self.index = self.index.saturating_sub(1);
+                    self.pages.rewind();
                     self.edit_message(interaction, false).await?;
                 }
                 "⏹️" => {
                     return self.edit_message(interaction, true).await;
                 }
                 "▶️" => {
-                    self.index = self.index.saturating_add(1).max(self.pages.len() - 1);
+                    self.pages.advance();
                     self.edit_message(interaction, false).await?;
                 }
                 "⏭️" => {
-                    self.index = self.pages.len() - 1;
+                    self.pages.jump_end();
                     self.edit_message(interaction, false).await?;
                 }
                 _ => unreachable!(),