tsk-85: Add file_type to CoverArt (#89)

Closes #85

Reviewed-on: #89
Co-authored-by: phoenix <kundeng00@pm.me>
Co-committed-by: phoenix <kundeng00@pm.me>

Cargo.lock

@@ -10,9 +10,9 @@ checksum = "320119579fcad9c21884f5c4861d16174d0e06250625266f50fe6898340abefa"
 
 [[package]]
 name = "aho-corasick"
-version = "1.1.3"
+version = "1.1.4"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "8e60d3430d3a69478ad0993f19238d2df97c507009a52b3c10addcd7f6bcb916"
+checksum = "ddd31a130427c27518df266943a5308ed92d4b226cc639f5a8f1002816174301"
 dependencies = [
  "memchr",
 ]
@@ -43,9 +43,9 @@ checksum = "46c5e41b57b8bba42a04676d81cb89e9ee8e859a1a66f80a5a72e1cb76b34d43"
 
 [[package]]
 name = "cc"
-version = "1.2.41"
+version = "1.2.43"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ac9fe6cdbb24b6ade63616c0a0688e45bb56732262c158df3c0c4bea4ca47cb7"
+checksum = "739eb0f94557554b3ca9a86d2d37bebd49c5e6d0c1d2bda35ba5bdac830befc2"
 dependencies = [
  "find-msvc-tools",
  "shlex",
@@ -68,9 +68,9 @@ dependencies = [
 
 [[package]]
 name = "deranged"
-version = "0.5.4"
+version = "0.5.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "a41953f86f8a05768a6cda24def994fd2f424b04ec5c719cf89989779f199071"
+checksum = "ececcb659e7ba858fb4f10388c250a7252eb0a27373f1a72b8748afdd248e587"
 dependencies = [
  "powerfmt",
  "serde_core",
@@ -106,9 +106,9 @@ checksum = "52051878f80a721bb68ebfbc930e07b65ba72f2da88968ea5c06fd6ca3d3a127"
 
 [[package]]
 name = "flate2"
-version = "1.1.4"
+version = "1.1.5"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "dc5a4e564e38c699f2880d3fda590bedc2e69f3f84cd48b457bd892ce61d0aa9"
+checksum = "bfe33edd8e85a12a67454e37f8c75e730830d83e313556ab9ebf9ee7fbeb3bfb"
 dependencies = [
  "crc32fast",
  "miniz_oxide",
@@ -149,7 +149,7 @@ checksum = "5419bdc4f6a9207fbeba6d11b604d481addf78ecd10c11ad51e76c2f6482748d"
 
 [[package]]
 name = "icarus_models"
-version = "0.8.0"
+version = "0.9.1"
 dependencies = [
  "josekit",
  "rand",
@@ -198,9 +198,9 @@ dependencies = [
 
 [[package]]
 name = "js-sys"
-version = "0.3.81"
+version = "0.3.82"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "ec48937a97411dcb524a265206ccd4c90bb711fca92b2792c407f268825b9305"
+checksum = "b011eec8cc36da2aab2d5cff675ec18454fad408585853910a202391cf9f8e65"
 dependencies = [
  "once_cell",
  "wasm-bindgen",
@@ -218,12 +218,6 @@ version = "0.11.0"
 source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "df1d3c3b53da64cf5760482273a98e575c651a67eec7f77df96b5b642de8f039"
 
-[[package]]
-name = "log"
-version = "0.4.28"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "34080505efa8e45a4b816c349525ebe327ceaa8559756f0356cba97ef3bf7432"
-
 [[package]]
 name = "memchr"
 version = "2.7.6"
@@ -313,9 +307,9 @@ dependencies = [
 
 [[package]]
 name = "proc-macro2"
-version = "1.0.101"
+version = "1.0.103"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "89ae43fd86e4158d6db51ad8e2b80f313af9cc74f5c0e03ccb87de09998732de"
+checksum = "5ee95bc4ef87b8d5ba32e8b7714ccc834865276eab0aed5c9958d00ec45f49e8"
 dependencies = [
  "unicode-ident",
 ]
@@ -476,9 +470,9 @@ checksum = "d66dc143e6b11c1eddc06d5c423cfc97062865baf299914ab64caa38182078fe"
 
 [[package]]
 name = "syn"
-version = "2.0.107"
+version = "2.0.108"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "2a26dbd934e5451d21ef060c018dae56fc073894c5a7896f882928a76e6d081b"
+checksum = "da58917d35242480a05c2897064da0a80589a2a0476c9a3f2fdc83b53502e917"
 dependencies = [
  "proc-macro2",
  "quote",
@@ -551,9 +545,9 @@ dependencies = [
 
 [[package]]
 name = "unicode-ident"
-version = "1.0.19"
+version = "1.0.20"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "f63a545481291138910575129486daeaf8ac54aee4387fe7906919f7830c7d9d"
+checksum = "462eeb75aeb73aea900253ce739c8e18a67423fadf006037cd3ff27e82748a06"
 
 [[package]]
 name = "utoipa"
@@ -608,9 +602,9 @@ dependencies = [
 
 [[package]]
 name = "wasm-bindgen"
-version = "0.2.104"
+version = "0.2.105"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "c1da10c01ae9f1ae40cbfac0bac3b1e724b320abfcf52229f80b547c0d250e2d"
+checksum = "da95793dfc411fbbd93f5be7715b0578ec61fe87cb1a42b12eb625caa5c5ea60"
 dependencies = [
  "cfg-if",
  "once_cell",
@@ -619,25 +613,11 @@ dependencies = [
  "wasm-bindgen-shared",
 ]
 
-[[package]]
-name = "wasm-bindgen-backend"
-version = "0.2.104"
-source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "671c9a5a66f49d8a47345ab942e2cb93c7d1d0339065d4f8139c486121b43b19"
-dependencies = [
- "bumpalo",
- "log",
- "proc-macro2",
- "quote",
- "syn",
- "wasm-bindgen-shared",
-]
-
 [[package]]
 name = "wasm-bindgen-macro"
-version = "0.2.104"
+version = "0.2.105"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "7ca60477e4c59f5f2986c50191cd972e3a50d8a95603bc9434501cf156a9a119"
+checksum = "04264334509e04a7bf8690f2384ef5265f05143a4bff3889ab7a3269adab59c2"
 dependencies = [
  "quote",
  "wasm-bindgen-macro-support",
@@ -645,22 +625,22 @@ dependencies = [
 
 [[package]]
 name = "wasm-bindgen-macro-support"
-version = "0.2.104"
+version = "0.2.105"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "9f07d2f20d4da7b26400c9f4a0511e6e0345b040694e8a75bd41d578fa4421d7"
+checksum = "420bc339d9f322e562942d52e115d57e950d12d88983a14c79b86859ee6c7ebc"
 dependencies = [
+ "bumpalo",
  "proc-macro2",
  "quote",
  "syn",
- "wasm-bindgen-backend",
  "wasm-bindgen-shared",
 ]
 
 [[package]]
 name = "wasm-bindgen-shared"
-version = "0.2.104"
+version = "0.2.105"
 source = "registry+https://github.com/rust-lang/crates.io-index"
-checksum = "bad67dc8b2a1a6e5448428adec4c3e84c43e561d8c9ee8a9e5aabeb193ec41d1"
+checksum = "76f218a38c84bcb33c25ec7059b07847d465ce0e0a76b995e134a45adcb6af76"
 dependencies = [
  "unicode-ident",
 ]

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "icarus_models"
-version = "0.8.0"
+version = "0.9.1"
 edition = "2024"
 rust-version = "1.90"
 description = "models used for the icarus project"

README.md

@@ -1,2 +1,3 @@
-A library containing commonly used models and functions that is used throughout
+A library containing commonly used structs, functions, enums, constants and other code
-icarus projects. This reduces the amount of duplicated code without a benefit.
+that is used throughout the icarus projects. Code from this library serves as the model
+for other projects in the icarus project.

src/constants.rs

@@ -12,3 +12,9 @@ pub mod file_extensions {
         pub const PNGEXTENSION: &str = ".png";
     }
 }
+
+pub mod error {
+    pub const DIRECTORY_NOT_INITIALIZED: &str = "Directory has not been initialized";
+    pub const FILENAME_NOT_INITIALIZED: &str = "Filename has not bee initialized";
+    pub const LAST_CHARACTER_IN_DIRECTORY: &str = "Could not access last character of directory";
+}

src/coverart.rs

@@ -1,25 +1,26 @@
 use std::io::Write;
 
-use serde::{Deserialize, Serialize};
+use rand::Rng;
 
-#[derive(Clone, Debug, Default, Deserialize, Serialize, utoipa::ToSchema)]
+const FILENAME_LENGTH: i32 = 16;
+
+#[derive(Clone, Debug, Default, serde::Deserialize, serde::Serialize, utoipa::ToSchema)]
 pub struct CoverArt {
     pub id: uuid::Uuid,
     pub title: String,
     #[serde(skip)]
     pub directory: String,
     pub filename: String,
+    pub file_type: String,
     #[serde(skip)]
     pub data: Vec<u8>,
     pub song_id: uuid::Uuid,
 }
 
 pub mod init {
-    use super::CoverArt;
-
     /// Initializes the CoverArt with just the directory and filename
-    pub fn init_coverart_dir_and_filename(directory: &str, filename: &str) -> CoverArt {
+    pub fn init_coverart_dir_and_filename(directory: &str, filename: &str) -> super::CoverArt {
-        CoverArt {
+        super::CoverArt {
             directory: String::from(directory),
             filename: String::from(filename),
             ..Default::default()
@@ -65,30 +66,67 @@ impl CoverArt {
     /// Gets the path of the CoverArt
     pub fn get_path(&self) -> Result<String, std::io::Error> {
         if self.directory.is_empty() {
-            return Err(std::io::Error::other("Directory has not been initialized"));
+            return Err(std::io::Error::other(
+                crate::constants::error::DIRECTORY_NOT_INITIALIZED,
+            ));
         } else if self.filename.is_empty() {
-            return Err(std::io::Error::other("Filename has not bee initialized"));
+            return Err(std::io::Error::other(
+                crate::constants::error::FILENAME_NOT_INITIALIZED,
+            ));
         }
 
         let directory = &self.directory;
         let last_index = directory.len() - 1;
 
-        if let Some(character) = directory.chars().nth(last_index) {
+        match crate::util::concatenate_path(directory, &self.filename, last_index) {
-            let buffer = if character != '/' {
+            Ok(path) => Ok(path),
-                directory.clone() + "/"
+            Err(err) => Err(err),
-            } else {
-                directory.clone()
-            };
-
-            Ok(buffer + &self.filename.clone())
-        } else {
-            Err(std::io::Error::other(
-                "Could not access last character of directory",
-            ))
         }
     }
 }
 
+/// Generates filename for a CoverArt
+pub fn generate_filename(
+    typ: crate::types::CoverArtType,
+    randomize: bool,
+) -> Result<String, std::io::Error> {
+    let file_extension = match typ {
+        crate::types::CoverArtType::PngExtension => {
+            String::from(crate::constants::file_extensions::image::PNGEXTENSION)
+        }
+        crate::types::CoverArtType::JpegExtension => {
+            String::from(crate::constants::file_extensions::image::JPEGEXTENSION)
+        }
+        crate::types::CoverArtType::JpgExtension => {
+            String::from(crate::constants::file_extensions::image::JPGEXTENSION)
+        }
+        crate::types::CoverArtType::None => {
+            return Err(std::io::Error::other("Unsupported CoverArtTypes"));
+        }
+    };
+
+    let filename: String = if randomize {
+        let mut filename: String = String::from("coverart-");
+        let some_chars: String = String::from("abcdefghij0123456789");
+        let some_chars_length = some_chars.len();
+        let mut rng = rand::rng();
+
+        for _ in 0..FILENAME_LENGTH {
+            let index = rng.random_range(0..=some_chars_length);
+            let rando_char = some_chars.chars().nth(index);
+
+            if let Some(c) = rando_char {
+                filename.push(c);
+            }
+        }
+        format!("{filename}{file_extension}")
+    } else {
+        format!("coverart-output{file_extension}")
+    };
+
+    Ok(filename)
+}
+
 pub mod io {
     use std::io::Read;
 

src/lib.rs

@@ -7,6 +7,7 @@ pub mod song;
 pub mod token;
 pub mod types;
 pub mod user;
+pub mod util;
 
 pub mod init {
     pub fn is_id_valid(num: &i32) -> bool {

src/song.rs

@@ -69,28 +69,24 @@ impl Song {
         }
     }
 
+    /// Gets the path of a Song
     pub fn song_path(&self) -> Result<String, std::io::Error> {
         if self.directory.is_empty() {
-            return Err(std::io::Error::other("Directory has not been initialized"));
+            return Err(std::io::Error::other(
+                crate::constants::error::DIRECTORY_NOT_INITIALIZED,
+            ));
         } else if self.filename.is_empty() {
-            return Err(std::io::Error::other("Filename has not bee initialized"));
+            return Err(std::io::Error::other(
+                crate::constants::error::FILENAME_NOT_INITIALIZED,
+            ));
         }
 
         let directory = &self.directory;
         let last_index = directory.len() - 1;
 
-        if let Some(character) = directory.chars().nth(last_index) {
+        match crate::util::concatenate_path(directory, &self.filename, last_index) {
-            let buffer: String = if character != '/' {
+            Ok(path) => Ok(path),
-                directory.clone() + "/"
+            Err(err) => Err(err),
-            } else {
-                directory.clone()
-            };
-
-            Ok(buffer + &self.filename.clone())
-        } else {
-            Err(std::io::Error::other(
-                "Could not access last character of directory",
-            ))
         }
     }
 
@@ -129,42 +125,44 @@ impl Song {
     }
 }
 
-/// Generates a filename. In order to save a song to the filesystem, the song must have
+/// Generates a filename. In order to save a song to the filesystem
-/// a directory and filename
+pub fn generate_filename(typ: types::MusicType, randomize: bool) -> Result<String, std::io::Error> {
-pub fn generate_filename(typ: types::MusicTypes, randomize: bool) -> String {
     let file_extension = match typ {
-        types::MusicTypes::DefaultMusicExtension => {
+        types::MusicType::DefaultMusicExtension => {
             String::from(constants::file_extensions::audio::DEFAULTMUSICEXTENSION)
         }
-
+        types::MusicType::WavExtension => {
-        types::MusicTypes::WavExtension => {
             String::from(constants::file_extensions::audio::WAVEXTENSION)
         }
-        types::MusicTypes::FlacExtension => {
+        types::MusicType::FlacExtension => {
             String::from(constants::file_extensions::audio::FLACEXTENSION)
         }
-        types::MusicTypes::MPThreeExtension => {
+        types::MusicType::MPThreeExtension => {
             String::from(constants::file_extensions::audio::MPTHREEEXTENSION)
         }
+        types::MusicType::None => return Err(std::io::Error::other("Unsupported MusicTypes")),
     };
 
-    if randomize {
+    let filename: String = if randomize {
-        let mut filename: String = String::new();
+        let mut filename: String = String::from("track-");
         let some_chars: String = String::from("abcdefghij0123456789");
+        let some_chars_length = some_chars.len();
         let mut rng = rand::rng();
 
         for _ in 0..FILENAME_LENGTH {
-            let index = rng.random_range(0..=19);
+            let index = rng.random_range(0..=some_chars_length);
             let rando_char = some_chars.chars().nth(index);
 
             if let Some(c) = rando_char {
                 filename.push(c);
             }
         }
-        filename + &file_extension
+        format!("{filename}{file_extension}")
     } else {
-        "track-output".to_string() + &file_extension
+        format!("track-output{file_extension}")
-    }
+    };
+
+    Ok(filename)
 }
 
 /// I/O operations for songs

src/types.rs

@@ -1,6 +1,16 @@
-pub enum MusicTypes {
+#[derive(Debug)]
+pub enum MusicType {
     DefaultMusicExtension,
     WavExtension,
     FlacExtension,
     MPThreeExtension,
+    None,
+}
+
+#[derive(Debug)]
+pub enum CoverArtType {
+    PngExtension,
+    JpegExtension,
+    JpgExtension,
+    None,
 }

src/util/mod.rs

@@ -0,0 +1,19 @@
+pub fn concatenate_path(
+    directory: &str,
+    filename: &str,
+    last_index: usize,
+) -> Result<String, std::io::Error> {
+    if let Some(character) = directory.chars().nth(last_index) {
+        let buffer: String = if character != '/' {
+            format!("{directory}/")
+        } else {
+            String::from(directory)
+        };
+
+        Ok(format!("{buffer}{filename}"))
+    } else {
+        Err(std::io::Error::other(
+            crate::constants::error::LAST_CHARACTER_IN_DIRECTORY,
+        ))
+    }
+}

tests/tests.rs

@@ -107,12 +107,21 @@ mod song_tests {
         };
 
         assert_eq!(song.directory.is_empty(), false);
-        song_cpy.filename = song::generate_filename(types::MusicTypes::FlacExtension, true);
+        match song::generate_filename(types::MusicType::FlacExtension, true) {
+            Ok(filename) => {
+                song_cpy.filename = filename;
+            }
+            Err(err) => {
+                assert!(false, "Error generatig filename: {err:?}");
+            }
+        };
         println!("Directory: {:?}", song_cpy.directory);
         println!("File to be created: {:?}", song_cpy.filename);
 
         match song::io::copy_song(&song, &mut song_cpy) {
-            Ok(_) => {}
+            Ok(_) => {
+                println!("Song copied");
+            }
             Err(err) => {
                 assert!(false, "Error copying song: Error: {err:?}")
             }