refactor: disallow inline non-test/priv submodules (#101)

* refactor: remove unneeded consts, move banner fn

Remove unnecessary constant definitions, primarily in the banner
printing function. Also move out the function from the constants module
to its own module `lyra/src/core/banner.rs`.

* refactor: disallow inline non-test/priv submodules

Disallow inlined submodules those aren't test or private (for sealing
trait implementations) modules in other rust modules. Prefer creating
rust files in a directory instead.

* style: add new lines between exit code constants

Also use `#[allow(unused)]` instead of commenting out unused constants
and add full stops in their documentation.

* refactor: move fuzzy matcher & url regex to statik

Move `lyra::src::core::konst::text::FuzzyMatcher` and to
`statik/fuzzy_matcher` and `konst::regex::URL` to `statik/regex` as they
previously do not belong in the constants module because they are
statics.

* refactor: rename `konst/colours.rs` to `colour.rs`

Rename `lyra/src/core/konst/colours.rs` to `colour.rs`.

* chore: update Cargo.lock, flake.lock

Author: fdnt7

Cargo.lock

@@ -34,7 +34,7 @@ use crate::{
     LavalinkAware,
     core::{
         konst::{
-            colours,
+            colour,
             poll::{BASE, DOWNVOTE, RATIO_BAR_SIZE, UPVOTE},
         },
         model::{
@@ -285,9 +285,9 @@ fn generate_upvote_button_id_and_row() -> (String, Component) {
 }
 
 fn generate_latent_embed_colours() -> LatentEmbedColours {
-    let upvote = mixbox::rgb_to_latent(&(hex_to_rgb(colours::UPVOTE)));
-    let downvote = mixbox::rgb_to_latent(&hex_to_rgb(colours::DOWNVOTE));
-    let base = mixbox::rgb_to_latent(&hex_to_rgb(colours::POLL_BASE));
+    let upvote = mixbox::rgb_to_latent(&(hex_to_rgb(colour::UPVOTE)));
+    let downvote = mixbox::rgb_to_latent(&hex_to_rgb(colour::DOWNVOTE));
+    let base = mixbox::rgb_to_latent(&hex_to_rgb(colour::POLL_BASE));
 
     LatentEmbedColours {
         base,

flake.lock

@@ -6,7 +6,7 @@ use twilight_util::builder::embed::EmbedBuilder;
 use crate::{
     command::model::{BotGuildSlashCommand, GuildSlashCmdCtx},
     core::{
-        konst::colours::EMBED_DEFAULT,
+        konst::colour::EMBED_DEFAULT,
         model::{DatabaseAware, response::initial::message::create::RespondWithMessage},
     },
     error::CommandResult,

lyra/src/command/poll.rs

@@ -35,11 +35,12 @@ use crate::{
     },
     core::{
         http::InteractionClient,
-        konst::{discord::COMMAND_CHOICES_LIMIT, misc::ADD_TRACKS_WRAP_LIMIT, text::FUZZY_MATCHER},
+        konst::{discord::COMMAND_CHOICES_LIMIT, misc::ADD_TRACKS_WRAP_LIMIT},
         model::{
             CacheAware,
             response::{either::RespondOrFollowup, initial::message::create::RespondWithMessage},
         },
+        statik::fuzzy_matcher::FUZZY_MATCHER,
     },
     error::{PositionOutOfRange as PositionOutOfRangeError, component::queue::RemoveTracksError},
     lavalink::{CorrectTrackInfo, QueueItem},

lyra/src/component/config/access/view.rs

@@ -37,7 +37,7 @@ use crate::{
         require, util,
     },
     core::{
-        konst::{discord::COMMAND_CHOICES_LIMIT, misc::ADD_TRACKS_WRAP_LIMIT, regex},
+        konst::{discord::COMMAND_CHOICES_LIMIT, misc::ADD_TRACKS_WRAP_LIMIT},
         model::{
             UserIdAware,
             response::{
@@ -48,6 +48,7 @@ use crate::{
                 },
             },
         },
+        statik::regex,
     },
     error::{
         CommandResult, LoadFailed as LoadFailedError,

lyra/src/component/queue/mod.rs

@@ -0,0 +1,52 @@
+use aho_corasick::AhoCorasick;
+
+/// Prints the bot's banner.
+///
+/// This includes the Λύρα icon, cargo package information and build-specific
+/// metadata.
+pub fn banner() -> String {
+    // we can afford to initialise the entire banner string without any memoisation,
+    // as this will only be called once, in `runner::start()`.
+
+    let metadata_patterns = [
+        "%version",
+        "%authors",
+        "%copyright",
+        "%build_timestamp",
+        "%git_describe",
+        "%git_sha",
+        "%git_commit_timestamp",
+        "%git_branch",
+        "%rustc_semver",
+        "%rustc_channel",
+        "%rustc_host",
+        "%rustc_commit_hash",
+        "%cargo_target_triple",
+        "%cargo_opt_level",
+    ];
+
+    let metadata_replacements = [
+        env!("CARGO_PKG_VERSION"),
+        env!("CARGO_PKG_AUTHORS"),
+        env!("CARGO_PKG_LICENSE"),
+        env!("VERGEN_BUILD_TIMESTAMP"),
+        env!("VERGEN_GIT_DESCRIBE"),
+        env!("VERGEN_GIT_SHA"),
+        env!("VERGEN_GIT_COMMIT_TIMESTAMP"),
+        env!("VERGEN_GIT_BRANCH"),
+        env!("VERGEN_RUSTC_SEMVER"),
+        env!("VERGEN_RUSTC_CHANNEL"),
+        env!("VERGEN_RUSTC_HOST_TRIPLE"),
+        env!("VERGEN_RUSTC_COMMIT_HASH"),
+        env!("VERGEN_CARGO_TARGET_TRIPLE"),
+        env!("VERGEN_CARGO_OPT_LEVEL"),
+    ];
+
+    let rdr = include_str!("../../../assets/lyra2-ascii.ans");
+    let mut wtr = Vec::new();
+
+    let ac = AhoCorasick::new(metadata_patterns).expect("METADATA_PATTERNS must be valid");
+    ac.try_stream_replace_all(rdr.as_bytes(), &mut wtr, &metadata_replacements)
+        .expect("searching must be infallible");
+    String::from_utf8(wtr).expect("interpolated banner must be utf-8")
+}

lyra/src/component/queue/play.rs

@@ -0,0 +1,4 @@
+pub const EMBED_DEFAULT: u32 = 0x82_6b_d6;
+pub const DOWNVOTE: u32 = 0xdd_2e_44;
+pub const UPVOTE: u32 = 0x58_65_f2;
+pub const POLL_BASE: u32 = 0x00_00_00;

lyra/src/core/banner.rs

@@ -0,0 +1,5 @@
+use std::time::Duration;
+
+pub const INACTIVITY_TIMEOUT: Duration = Duration::from_secs(600);
+pub const CHANGED_TIMEOUT: Duration = Duration::from_millis(250);
+pub const GET_LAVALINK_CONNECTION_INFO_TIMEOUT: Duration = Duration::from_millis(2_000);