Compare commits

..

5 Commits

Author SHA1 Message Date
13b030bbca tsk-57: Version bump
All checks were successful
Release Tagging / release (pull_request) Successful in 33s
Rust Build / Check (pull_request) Successful in 42s
Rust Build / Test Suite (pull_request) Successful in 49s
Rust Build / Rustfmt (pull_request) Successful in 24s
Rust Build / build (pull_request) Successful in 27s
Rust Build / Clippy (pull_request) Successful in 1m6s
2025-08-19 18:26:22 -04:00
1c1826ff32 tsk-57: Added schema to models
All checks were successful
Rust Build / Test Suite (pull_request) Successful in 36s
Release Tagging / release (pull_request) Successful in 38s
Rust Build / Check (pull_request) Successful in 49s
Rust Build / Rustfmt (pull_request) Successful in 36s
Rust Build / Clippy (pull_request) Successful in 51s
Rust Build / build (pull_request) Successful in 43s
2025-08-19 18:24:55 -04:00
57fd5c3029 tsk-57: Added time feature to utoipa 2025-08-19 18:24:26 -04:00
0950267a48 tsk-57: Added uuid feature for utoipa 2025-08-19 18:21:06 -04:00
abfec8d287 tsk-57: Adding utoipia crate for documentation
All checks were successful
Release Tagging / release (pull_request) Successful in 39s
Rust Build / Test Suite (pull_request) Successful in 57s
Rust Build / Check (pull_request) Successful in 59s
Rust Build / Rustfmt (pull_request) Successful in 29s
Rust Build / Clippy (pull_request) Successful in 36s
Rust Build / build (pull_request) Successful in 51s
2025-08-19 18:08:10 -04:00
5 changed files with 94 additions and 154 deletions

2
Cargo.lock generated
View File

@@ -142,7 +142,7 @@ checksum = "5971ac85611da7067dbfcabef3c70ebb5606018acd9e2a3903a0da507521e0d5"
[[package]] [[package]]
name = "icarus_models" name = "icarus_models"
version = "0.6.3" version = "0.5.6"
dependencies = [ dependencies = [
"josekit", "josekit",
"rand", "rand",

View File

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

View File

@@ -37,9 +37,6 @@ impl CoverArt {
Err(err) => Err(err), Err(err) => Err(err),
} }
} }
// TODO: Add method to save to filesystem
// TODO: Add method to remove from filesystem
} }
#[cfg(test)] #[cfg(test)]

View File

@@ -1,14 +1,11 @@
use std::io::Write; use std::io::Read;
use rand::Rng;
use serde::{Deserialize, Serialize};
use crate::constants; use crate::constants;
use crate::init; use crate::init;
use crate::types; use crate::types;
/// Length of characters of a filename to be generated use rand::Rng;
const FILENAME_LENGTH: i32 = 16; use serde::{Deserialize, Serialize};
#[derive(Clone, Debug, Default, Deserialize, Serialize, utoipa::ToSchema)] #[derive(Clone, Debug, Default, Deserialize, Serialize, utoipa::ToSchema)]
pub struct Song { pub struct Song {
@@ -93,42 +90,29 @@ impl Song {
} }
} }
/// Saves the song to the filesystem using the song's data pub fn to_data(&self) -> Result<Vec<u8>, std::io::Error> {
pub fn save_to_filesystem(&self) -> Result<(), std::io::Error> { let path_result = self.song_path();
match self.song_path() {
Ok(song_path) => match std::fs::File::create(&song_path) {
Ok(mut file) => match file.write_all(&self.data) {
Ok(_res) => Ok(()),
Err(err) => Err(err),
},
Err(err) => Err(err),
},
Err(err) => Err(err),
}
}
/// Removes the song from the filesystem match path_result {
pub fn remove_from_filesystem(&self) -> Result<(), std::io::Error> { Ok(path) => {
match self.song_path() { let mut file = std::fs::File::open(path)?;
Ok(song_path) => { let mut buffer: Vec<u8> = Vec::new();
let p = std::path::Path::new(&song_path); file.read_to_end(&mut buffer)?;
if p.exists() {
match std::fs::remove_file(&p) { if buffer.is_empty() {
Ok(_) => Ok(()), Err(std::io::Error::other("File is empty"))
Err(err) => Err(err),
}
} else { } else {
Ok(()) Ok(buffer)
} }
} }
Err(err) => Err(err), Err(er) => Err(er),
}
} }
} }
/// Generates a filename. In order to save a song to the filesystem, the song must have pub fn generate_filename(&self, typ: types::MusicTypes, randomize: bool) -> String {
/// a directory and filename let mut filename: String = String::new();
pub fn generate_filename(typ: types::MusicTypes, randomize: bool) -> String { let filename_len = 10;
let file_extension = match typ { let file_extension = match typ {
types::MusicTypes::DefaultMusicExtension => { types::MusicTypes::DefaultMusicExtension => {
String::from(constants::file_extensions::audio::DEFAULTMUSICEXTENSION) String::from(constants::file_extensions::audio::DEFAULTMUSICEXTENSION)
@@ -146,73 +130,24 @@ pub fn generate_filename(typ: types::MusicTypes, randomize: bool) -> String {
}; };
if randomize { if randomize {
let mut filename: String = String::new();
let some_chars: String = String::from("abcdefghij0123456789"); let some_chars: String = String::from("abcdefghij0123456789");
let mut rng = rand::rng(); let mut rng = rand::rng();
for _ in 0..FILENAME_LENGTH { for _i in 0..filename_len {
let index = rng.random_range(0..=19); let random_number: i32 = rng.random_range(0..=19);
let index = random_number as usize;
let rando_char = some_chars.chars().nth(index); let rando_char = some_chars.chars().nth(index);
if let Some(c) = rando_char { if let Some(c) = rando_char {
filename.push(c); filename.push(c);
} }
} }
filename + &file_extension
} else { } else {
"track-output".to_string() + &file_extension filename += "track-output";
}
} }
/// I/O operations for songs filename += &file_extension;
pub mod io {
use std::io::Read;
/// Copies a song using the source song's data filename
pub fn copy_song(
song_source: &super::Song,
song_target: &mut super::Song,
) -> Result<(), std::io::Error> {
match song_target.song_path() {
Ok(songpath) => {
let p = std::path::Path::new(&songpath);
if p.exists() {
Err(std::io::Error::other(
"Cannot copy song over to one that already exists",
))
} else {
if song_target.data.is_empty() {
song_target.data = song_source.data.clone();
} else {
song_target.data.clear();
song_target.data = song_source.data.clone();
}
match song_target.save_to_filesystem() {
Ok(_) => Ok(()),
Err(err) => Err(err),
}
}
}
Err(err) => Err(err),
}
}
/// Gets the raw file data of a song from the filesystem
pub fn to_data(song: &super::Song) -> Result<Vec<u8>, std::io::Error> {
match song.song_path() {
Ok(path) => {
let mut file = std::fs::File::open(path)?;
let mut buffer: Vec<u8> = Vec::new();
file.read_to_end(&mut buffer)?;
if buffer.is_empty() {
Err(std::io::Error::other("File is empty"))
} else {
Ok(buffer)
}
}
Err(er) => Err(er),
}
} }
} }

View File

@@ -30,12 +30,16 @@ mod utils {
#[cfg(test)] #[cfg(test)]
mod song_tests { mod song_tests {
use std::fs::File;
use std::io::Write;
use tempfile::tempdir; use tempfile::tempdir;
use crate::utils;
use icarus_models::song; use icarus_models::song;
use icarus_models::types; use icarus_models::types;
use crate::utils;
#[test] #[test]
fn test_song_to_data() { fn test_song_to_data() {
println!("Test"); println!("Test");
@@ -61,7 +65,7 @@ mod song_tests {
Ok(buffer) => { Ok(buffer) => {
assert_eq!(buffer.is_empty(), false); assert_eq!(buffer.is_empty(), false);
match song::io::to_data(&song) { match song.to_data() {
Ok(song_data) => { Ok(song_data) => {
println!("Both files match"); println!("Both files match");
assert_eq!(buffer, song_data); assert_eq!(buffer, song_data);
@@ -99,6 +103,9 @@ mod song_tests {
song.directory = utils::get_tests_directory(); song.directory = utils::get_tests_directory();
song.filename = String::from("track01.flac"); song.filename = String::from("track01.flac");
match song.song_path() {
Ok(songpath) => match utils::extract_data_from_file(&songpath) {
Ok(buffer) => {
let mut song_cpy = song.clone(); let mut song_cpy = song.clone();
let temp_dir = tempdir().expect("Failed to create temp dir"); let temp_dir = tempdir().expect("Failed to create temp dir");
song_cpy.directory = match temp_dir.path().to_str() { song_cpy.directory = match temp_dir.path().to_str() {
@@ -107,39 +114,39 @@ mod song_tests {
}; };
assert_eq!(song.directory.is_empty(), false); assert_eq!(song.directory.is_empty(), false);
song_cpy.filename = song::generate_filename(types::MusicTypes::FlacExtension, true); song_cpy.filename =
song.generate_filename(types::MusicTypes::FlacExtension, true);
println!("Directory: {:?}", song_cpy.directory); println!("Directory: {:?}", song_cpy.directory);
println!("File to be created: {:?}", song_cpy.filename); println!("File to be created: {:?}", song_cpy.filename);
match song::io::copy_song(&song, &mut song_cpy) { let path = match song_cpy.song_path() {
Ok(_) => {} Ok(s_path) => s_path,
Err(err) => { Err(err) => {
assert!(false, "Error copying song: Error: {err:?}") assert!(false, "Error: {:?}", err);
String::new()
} }
}
}
#[test]
fn test_save_song_to_filesystem_and_remove() {
let mut song = song::Song::default();
song.directory = utils::get_tests_directory();
song.filename = String::from("track02.flac");
let mut copied_song = song::Song {
directory: utils::get_tests_directory(),
filename: String::from("track02-coppied.flac"),
..Default::default()
}; };
match song::io::copy_song(&song, &mut copied_song) { match File::create(path) {
Ok(_) => match copied_song.remove_from_filesystem() { Ok(mut file_cpy) => match file_cpy.write_all(&buffer) {
Ok(_) => {} Ok(success) => {
println!("Success: {:?}", success);
}
Err(err) => { Err(err) => {
assert!(false, "Error: {err:?}") assert!(false, "Error saving file: {:?}", err);
} }
}, },
Err(err) => { Err(err) => {
assert!(false, "Error: {err:?}") assert!(false, "Error: {:?}", err);
}
};
}
Err(err) => {
assert!(false, "Error: {:?}", err);
}
},
Err(err) => {
assert!(false, "Error extracting song data: {:?}", err);
} }
} }
} }
@@ -147,6 +154,7 @@ mod song_tests {
#[cfg(test)] #[cfg(test)]
mod album_tests { mod album_tests {
use crate::utils; use crate::utils;
use icarus_models::album; use icarus_models::album;