Merge pull request 'Song changes' (#60) from song_changes into main

Reviewed-on: #60

Cargo.lock

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

Cargo.toml

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

src/coverart.rs

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

src/song.rs

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

tests/tests.rs

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