Merge pull request 'v0.2.0 Release' (#20) from devel into main

Reviewed-on: phoenix/icarus-models#20

.gitea/workflows/tag_release.yaml

@@ -3,14 +3,13 @@ name: Release Tagging
 on:
   push:
     branches:
-      - main
       - devel
     tags:
       - 'v*' # Trigger on tags matching v*
 
 jobs:
   release:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - name: Checkout code
         uses: actions/checkout@v3

.gitea/workflows/workflow.yaml

@@ -13,7 +13,7 @@ on:
 jobs:
   check:
     name: Check
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions-rust-lang/setup-rust-toolchain@v1
@@ -23,7 +23,7 @@ jobs:
 
   test:
     name: Test Suite
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions-rust-lang/setup-rust-toolchain@v1
@@ -33,7 +33,7 @@ jobs:
 
   fmt:
     name: Rustfmt
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions-rust-lang/setup-rust-toolchain@v1
@@ -44,7 +44,7 @@ jobs:
 
   clippy:
     name: Clippy
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions-rust-lang/setup-rust-toolchain@v1
@@ -55,7 +55,7 @@ jobs:
 
   build:
     name: build
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-24.04
     steps:
       - uses: actions/checkout@v4
       - uses: actions-rust-lang/setup-rust-toolchain@v1

.gitignore

@@ -1 +1,2 @@
 /target
+Cargo.lock

Cargo.toml

@@ -1,6 +1,6 @@
 [package]
-name = "icarus-models"
-version = "0.1.14"
+name = "icarus_models"
+version = "0.2.0"
 edition = "2024"
 description = "models used for the icarus project"
 license = "MIT"
@@ -9,3 +9,4 @@ license = "MIT"
 serde = { version = "1.0.218", features = ["derive"] }
 serde_json = { version = "1.0.139" }
 rand = { version = "0.9" }
+tempfile = { version = "3.19.1" }

src/album.rs

@@ -1,15 +1,29 @@
 pub mod collection {
     use serde::{Deserialize, Serialize};
+    use std::default::Default;
+
+    use std::fs::File;
+    use std::io::BufReader;
 
     fn is_set(num: &i32) -> bool {
         *num >= 0
     }
 
-    #[derive(Clone, Debug, Deserialize, Serialize)]
+    pub fn parse_album(filepath: &String) -> Result<Album, serde_json::Error> {
+        let file = File::open(filepath).expect("Failed to open file");
+        let reader = BufReader::new(file);
+
+        serde_json::from_reader(reader)
+    }
+
+    #[derive(Clone, Debug, Default, Deserialize, Serialize)]
     pub struct Album {
         #[serde(skip_serializing_if = "String::is_empty")]
         #[serde(alias = "album")]
         pub title: String,
+        #[serde(skip_serializing_if = "String::is_empty")]
+        #[serde(alias = "album_artist")]
+        pub artist: String,
         pub genre: String,
         pub year: i32,
         pub track_count: i32,
@@ -19,7 +33,7 @@ pub mod collection {
         pub tracks: Vec<Track>,
     }
 
-    #[derive(Clone, Debug, Deserialize, Serialize)]
+    #[derive(Clone, Debug, Default, Deserialize, Serialize)]
     pub struct Track {
         pub title: String,
         pub artist: String,

src/constants.rs

@@ -1,5 +1,14 @@
-pub const DEFAULTMUSICEXTENSION: &str = FLACEXTENSION;
-pub const FLACEXTENSION: &str = ".flac";
-pub const WAVEXTENSION: &str = ".wav";
-pub const MPTHREEEXTENSION: &str = ".mp3";
-pub const JPGEXTENSION: &str = ".jpg";
+pub mod file_extensions {
+    pub mod audio {
+        pub const DEFAULTMUSICEXTENSION: &str = FLACEXTENSION;
+        pub const FLACEXTENSION: &str = ".flac";
+        pub const WAVEXTENSION: &str = ".wav";
+        pub const MPTHREEEXTENSION: &str = ".mp3";
+    }
+
+    pub mod image {
+        pub const JPGEXTENSION: &str = ".jpg";
+        pub const JPEGEXTENSION: &str = ".jpeg";
+        pub const PNGEXTENSION: &str = ".png";
+    }
+}

src/coverart.rs

@@ -2,7 +2,7 @@ use std::io::Read;
 
 use serde::{Deserialize, Serialize};
 
-#[derive(Debug, Clone, Deserialize, Serialize)]
+#[derive(Clone, Debug, Default, Deserialize, Serialize)]
 pub struct CoverArt {
     pub id: i32,
     pub title: String,

src/lib.rs

@@ -7,18 +7,3 @@ pub mod song;
 pub mod token;
 pub mod types;
 pub mod user;
-
-pub fn add(left: u64, right: u64) -> u64 {
-    left + right
-}
-
-#[cfg(test)]
-mod tests {
-    use super::*;
-
-    #[test]
-    fn it_works() {
-        let result = add(2, 2);
-        assert_eq!(result, 4);
-    }
-}

src/song.rs

@@ -1,4 +1,3 @@
-// use std::default::Default;
 use std::io::Read;
 
 use crate::constants;
@@ -7,7 +6,7 @@ use crate::types;
 use rand::Rng;
 use serde::{Deserialize, Serialize};
 
-#[derive(Clone, Debug, Deserialize, Serialize)]
+#[derive(Clone, Debug, Default, Deserialize, Serialize)]
 pub struct Song {
     #[serde(skip_serializing_if = "is_zero")]
     #[serde(alias = "id")]
@@ -64,37 +63,6 @@ fn is_dur_not_set(num: &i32) -> bool {
     *num == 0
 }
 
-/*
-impl Default for Song {
-    fn default() -> Self {
-        Song {
-            id: 0,
-            title: String::new(),
-            artist: String::new(),
-            album: String::new(),
-            album_artist: String::new(),
-            genre: String::new(),
-            year: 0,
-            duration: 0,
-            track: 0,
-            disc: 0,
-            disc_count: 0,
-            track_count: 0,
-            audio_type: String::new(),
-            date_created: String::new(),
-            filename: String::new(),
-            user_id: 0,
-            data: Vec::new(),
-            directory: String::new(),
-            // album_id: 0,
-            // artist_id: 0,
-            // genre_id: 0,
-            // coverart_id: 0,
-        }
-    }
-}
-*/
-
 impl Song {
     pub fn to_metadata_json(&self, pretty: bool) -> Result<String, serde_json::Error> {
         if pretty {
@@ -160,12 +128,18 @@ impl Song {
 
         let file_extension = match typ {
             types::MusicTypes::DefaultMusicExtension => {
-                String::from(constants::DEFAULTMUSICEXTENSION)
+                String::from(constants::file_extensions::audio::DEFAULTMUSICEXTENSION)
             }
 
-            types::MusicTypes::WavExtension => String::from(constants::WAVEXTENSION),
-            types::MusicTypes::FlacExtension => String::from(constants::FLACEXTENSION),
-            types::MusicTypes::MPThreeExtension => String::from(constants::MPTHREEEXTENSION),
+            types::MusicTypes::WavExtension => {
+                String::from(constants::file_extensions::audio::WAVEXTENSION)
+            }
+            types::MusicTypes::FlacExtension => {
+                String::from(constants::file_extensions::audio::FLACEXTENSION)
+            }
+            types::MusicTypes::MPThreeExtension => {
+                String::from(constants::file_extensions::audio::MPTHREEEXTENSION)
+            }
         };
 
         if randomize {

tests/album.json

@@ -0,0 +1,31 @@
+{
+  "album": "Sample Tracks! Yes",
+  "album_artist": "KD",
+  "genre": "Country",
+  "year": 2025,
+  "track_count": 3,
+  "disc_count": 1,
+  "tracks": [
+    {
+      "title": "E less",
+      "artist": "KD",
+      "disc": 1,
+      "track": 1,
+      "duration": 31
+    },
+    {
+      "title": "Aaaaaye",
+      "artist": "KD",
+      "disc": 1,
+      "track": 2,
+      "duration": 33
+    },
+    {
+      "title": "Check D out",
+      "artist": "KD",
+      "disc": 1,
+      "track": 3,
+      "duration": 22
+    }
+  ]
+}

tests/tests.rs

@@ -0,0 +1,179 @@
+mod utils {
+    use std::fs;
+    use std::io::Read;
+    use std::path::Path;
+
+    pub fn get_tests_directory() -> String {
+        String::from(env!("CARGO_MANIFEST_DIR").to_owned() + "/tests/")
+    }
+
+    pub fn does_directory_exists(directory: &String) -> bool {
+        let path = Path::new(directory);
+        if let Ok(dir_i) = fs::metadata(path) {
+            dir_i.is_dir()
+        } else {
+            false
+        }
+    }
+
+    pub fn extract_data_from_file(filepath: &String) -> Result<Vec<u8>, std::io::Error> {
+        match std::fs::File::open(filepath) {
+            Ok(mut file) => {
+                let mut buffer: Vec<u8> = Vec::new();
+                let _ = file.read_to_end(&mut buffer);
+                Ok(buffer)
+            }
+            Err(err) => Err(err),
+        }
+    }
+}
+
+mod song_tests {
+    use std::fs::File;
+    use std::io::Write;
+
+    use tempfile::tempdir;
+
+    use icarus_models::song;
+    use icarus_models::types;
+
+    use crate::utils;
+
+    #[test]
+    fn test_song_to_data() {
+        println!("Test");
+        let some_val = true;
+
+        println!("Checking if some_val is true");
+        assert_eq!(true, some_val);
+
+        println!("Getting track");
+        let mut song = song::Song::default();
+        song.directory = utils::get_tests_directory();
+        song.filename = String::from("track01.flac");
+
+        assert!(
+            utils::does_directory_exists(&song.directory),
+            "Directory does not exist"
+        );
+
+        println!("Directory: {}", song.directory);
+
+        match song.song_path() {
+            Ok(filepath) => match utils::extract_data_from_file(&filepath) {
+                Ok(buffer) => {
+                    assert_eq!(buffer.is_empty(), false);
+
+                    match song.to_data() {
+                        Ok(song_data) => {
+                            println!("Both files match");
+                            assert_eq!(buffer, song_data);
+                        }
+                        Err(err) => {
+                            assert!(false, "Error producing song data: {:?}", err);
+                        }
+                    };
+                }
+                Err(err) => {
+                    assert!(false, "Failed to open file: {:?}", err);
+                }
+            },
+            Err(err) => {
+                assert!(false, "Could not get song path: {:?}", err);
+            }
+        }
+    }
+
+    #[test]
+    fn test_song_path_check() {
+        let mut song = song::Song::default();
+        song.directory = utils::get_tests_directory();
+        song.filename = String::from("track01.flac");
+
+        assert!(
+            utils::does_directory_exists(&song.directory),
+            "Directory does not exist"
+        );
+    }
+
+    #[test]
+    fn test_song_generate_filename() {
+        let mut song = song::Song::default();
+        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() {
+                        Some(s) => String::from(s),
+                        None => String::new(),
+                    };
+
+                    assert_eq!(song.directory.is_empty(), false);
+                    song_cpy.filename =
+                        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() {
+                        Ok(s_path) => s_path,
+                        Err(err) => {
+                            assert!(false, "Error: {:?}", err);
+                            String::new()
+                        }
+                    };
+
+                    match File::create(path) {
+                        Ok(mut file_cpy) => match file_cpy.write_all(&buffer) {
+                            Ok(success) => {
+                                println!("Success: {:?}", success);
+                            }
+                            Err(err) => {
+                                assert!(false, "Error saving file: {:?}", err);
+                            }
+                        },
+                        Err(err) => {
+                            assert!(false, "Error: {:?}", err);
+                        }
+                    };
+                }
+                Err(err) => {
+                    assert!(false, "Error: {:?}", err);
+                }
+            },
+            Err(err) => {
+                assert!(false, "Error extracting song data: {:?}", err);
+            }
+        }
+    }
+}
+
+mod album_tests {
+
+    use crate::utils;
+    use icarus_models::album;
+
+    #[test]
+    fn parse_album() {
+        let test_dir = utils::get_tests_directory();
+        if utils::does_directory_exists(&test_dir) {
+            let album_file: String = test_dir + &String::from("album.json");
+            println!("Album file: {:?}", album_file);
+
+            match album::collection::parse_album(&album_file) {
+                Ok(album) => {
+                    println!("Album title: {}", album.title);
+                    assert_eq!(album.title.is_empty(), false);
+                    assert_eq!(album.artist.is_empty(), false);
+                    assert_eq!(album.tracks.is_empty(), false);
+                }
+                Err(err) => {
+                    assert!(false, "Error parsing album json file: {:?}", err);
+                }
+            }
+        }
+    }
+}