Merge pull request 'Next release' (#25) from devel into main

Reviewed-on: #25

.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

Cargo.toml

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

src/access_level.rs

@@ -4,34 +4,34 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct AccessLevel {
-    pub id: i32,
+    pub id: uuid::Uuid,
     pub level: String,
-    pub song_id: i32,
+    pub song_id: uuid::Uuid,
 }
 
 impl Default for AccessLevel {
     fn default() -> Self {
         AccessLevel {
-            id: -1,
+            id: uuid::Uuid::nil(),
             level: String::new(),
-            song_id: -1,
+            song_id: uuid::Uuid::new_v4(),
         }
     }
 }
 
 pub fn default_level() -> AccessLevel {
     AccessLevel {
-        id: -1,
+        id: uuid::Uuid::nil(),
         level: String::from("Public"),
-        song_id: -1,
+        song_id: uuid::Uuid::new_v4(),
     }
 }
 
 pub fn private_level() -> AccessLevel {
     AccessLevel {
-        id: -1,
+        id: uuid::Uuid::new_v4(),
         level: String::from("Private"),
-        song_id: -1,
+        song_id: uuid::Uuid::new_v4(),
     }
 }
 

src/album.rs

@@ -1,25 +1,37 @@
 pub mod collection {
     use serde::{Deserialize, Serialize};
+    use std::default::Default;
 
-    fn is_set(num: &i32) -> bool {
-        *num >= 0
+    use std::fs::File;
+    use std::io::BufReader;
+
+    use crate::init;
+
+    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, Deserialize, Serialize)]
+    #[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,
-        #[serde(skip_serializing_if = "is_set")]
+        #[serde(skip_serializing_if = "init::is_set")]
         pub disc_count: i32,
         #[serde(skip_serializing_if = "Vec::is_empty")]
         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 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,14 +2,27 @@ 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 id: uuid::Uuid,
     pub title: String,
     pub path: String,
     pub data: Vec<u8>,
 }
 
+pub mod init {
+    use crate::coverart::CoverArt;
+
+    pub fn init_coverart_only_path(path: String) -> CoverArt {
+        CoverArt {
+            id: uuid::Uuid::nil(),
+            title: String::new(),
+            path: path.clone(),
+            data: Vec::new(),
+        }
+    }
+}
+
 impl CoverArt {
     pub fn to_data(&self) -> Result<Vec<u8>, std::io::Error> {
         let path: &String = &self.path;
@@ -21,3 +34,16 @@ impl CoverArt {
         }
     }
 }
+
+#[cfg(test)]
+mod tests {
+    use crate::coverart;
+
+    #[test]
+    fn test_cover_art_image() {
+        let path: String = String::from("somepath");
+        let coverart = coverart::init::init_coverart_only_path(path.clone());
+
+        assert_eq!(path, coverart.path);
+    }
+}

src/lib.rs

@@ -7,3 +7,25 @@ pub mod song;
 pub mod token;
 pub mod types;
 pub mod user;
+
+pub mod init {
+    pub fn is_id_valid(num: &i32) -> bool {
+        *num > 0
+    }
+
+    pub fn is_uuid_nil(uuid: &uuid::Uuid) -> bool {
+        uuid.is_nil()
+    }
+
+    pub fn is_zero(num: &i32) -> bool {
+        *num == 0
+    }
+
+    pub fn is_dur_not_set(num: &i32) -> bool {
+        *num == 0
+    }
+
+    pub fn is_set(num: &i32) -> bool {
+        *num >= 0
+    }
+}

src/login_result.rs

@@ -4,7 +4,7 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct LoginResult {
-    pub id: i32,
+    pub id: uuid::Uuid,
     pub username: String,
     pub token: String,
     #[serde(alias = "token_type")]
@@ -15,7 +15,7 @@ pub struct LoginResult {
 impl Default for LoginResult {
     fn default() -> Self {
         LoginResult {
-            id: -1,
+            id: uuid::Uuid::nil(),
             username: String::new(),
             token: String::new(),
             token_type: String::new(),

src/song.rs

@@ -1,6 +1,7 @@
 use std::io::Read;
 
 use crate::constants;
+use crate::init;
 use crate::types;
 
 use rand::Rng;
@@ -8,9 +9,9 @@ use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Debug, Default, Deserialize, Serialize)]
 pub struct Song {
-    #[serde(skip_serializing_if = "is_zero")]
+    #[serde(skip_serializing_if = "init::is_uuid_nil")]
     #[serde(alias = "id")]
-    pub id: i32,
+    pub id: uuid::Uuid,
     #[serde(skip_serializing_if = "String::is_empty")]
     pub title: String,
     #[serde(skip_serializing_if = "String::is_empty")]
@@ -21,17 +22,17 @@ pub struct Song {
     pub album_artist: String,
     #[serde(skip_serializing_if = "String::is_empty")]
     pub genre: String,
-    #[serde(skip_serializing_if = "is_zero")]
+    #[serde(skip_serializing_if = "init::is_zero")]
     pub year: i32,
-    #[serde(skip_serializing_if = "is_dur_not_set")]
+    #[serde(skip_serializing_if = "init::is_dur_not_set")]
     pub duration: i32,
-    #[serde(skip_serializing_if = "is_zero")]
+    #[serde(skip_serializing_if = "init::is_zero")]
     pub track: i32,
-    #[serde(skip_serializing_if = "is_zero")]
+    #[serde(skip_serializing_if = "init::is_zero")]
     pub disc: i32,
-    #[serde(skip_serializing_if = "is_zero")]
+    #[serde(skip_serializing_if = "init::is_zero")]
     pub disc_count: i32,
-    #[serde(skip_serializing_if = "is_zero")]
+    #[serde(skip_serializing_if = "init::is_zero")]
     pub track_count: i32,
     #[serde(skip_serializing_if = "String::is_empty")]
     pub audio_type: String,
@@ -39,8 +40,8 @@ pub struct Song {
     pub date_created: String,
     #[serde(skip_serializing_if = "String::is_empty")]
     pub filename: String,
-    #[serde(skip_serializing_if = "is_zero")]
-    pub user_id: i32,
+    #[serde(skip_serializing_if = "init::is_uuid_nil")]
+    pub user_id: uuid::Uuid,
     #[serde(skip)]
     pub data: Vec<u8>,
     #[serde(skip)]
@@ -55,14 +56,6 @@ pub struct Song {
     // pub coverart_id: i32,
 }
 
-fn is_zero(num: &i32) -> bool {
-    *num == 0
-}
-
-fn is_dur_not_set(num: &i32) -> bool {
-    *num == 0
-}
-
 impl Song {
     pub fn to_metadata_json(&self, pretty: bool) -> Result<String, serde_json::Error> {
         if pretty {
@@ -128,12 +121,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 {
@@ -228,9 +227,9 @@ mod embedded {
     // The song's duration is a floating point in seconds
     #[derive(Clone, Debug, Deserialize, Serialize)]
     pub struct Song {
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_uuid_nil")]
         #[serde(alias = "id")]
-        pub id: i32,
+        pub id: uuid::Uuid,
         #[serde(skip_serializing_if = "String::is_empty")]
         pub title: String,
         #[serde(skip_serializing_if = "String::is_empty")]
@@ -241,17 +240,17 @@ mod embedded {
         pub album_artist: String,
         #[serde(skip_serializing_if = "String::is_empty")]
         pub genre: String,
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_embed_zero")]
         pub year: i32,
-        #[serde(skip_serializing_if = "is_embed_dur_not_set")]
+        #[serde(skip_serializing_if = "init::is_embed_dur_not_set")]
         pub duration: f64,
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_embed_zero")]
         pub track: i32,
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_embed_zero")]
         pub disc: i32,
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_embed_zero")]
         pub disc_count: i32,
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_embed_zero")]
         pub track_count: i32,
         #[serde(skip_serializing_if = "String::is_empty")]
         pub audio_type: String,
@@ -259,7 +258,7 @@ mod embedded {
         pub date_created: String,
         #[serde(skip_serializing_if = "String::is_empty")]
         pub filename: String,
-        #[serde(skip_serializing_if = "is_embed_zero")]
+        #[serde(skip_serializing_if = "init::is_embed_zero")]
         pub user_id: i32,
         #[serde(skip)]
         pub data: Vec<u8>,
@@ -275,18 +274,11 @@ mod embedded {
         // pub coverart_id: i32,
     }
 
-    fn is_embed_zero(num: &i32) -> bool {
-        *num == 0
-    }
-
-    fn is_embed_dur_not_set(num: &f64) -> bool {
-        *num == 0.0
-    }
 
     impl Default for Song {
         fn default() -> Self {
             Song {
-                id: 0,
+                id: uuid::Uuid::nil(),
                 title: String::new(),
                 artist: String::new(),
                 album: String::new(),

src/token.rs

@@ -13,8 +13,8 @@ pub struct Token {
 
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct AccessToken {
-    #[serde(alias = "user_id")]
-    pub user_id: i32,
+    #[serde(alias = "init::is_uuid_nil")]
+    pub user_id: uuid::Uuid,
     #[serde(alias = "username")]
     pub username: String,
     #[serde(alias = "token")]

src/user.rs

@@ -1,11 +1,13 @@
 use std::default::Default;
 
+use crate::init;
+
 use serde::{Deserialize, Serialize};
 
 #[derive(Clone, Debug, Deserialize, Serialize)]
 pub struct User {
-    #[serde(skip_serializing_if = "is_id_valid")]
-    pub id: i32,
+    #[serde(skip_serializing_if = "init::is_uuid_nil")]
+    pub id: uuid::Uuid,
     #[serde(skip_serializing_if = "String::is_empty")]
     pub username: String,
     #[serde(skip_serializing_if = "String::is_empty")]
@@ -27,14 +29,10 @@ pub struct User {
     pub last_login: String,
 }
 
-fn is_id_valid(num: &i32) -> bool {
-    *num > 0
-}
-
 impl Default for User {
     fn default() -> Self {
         User {
-            id: -1,
+            id: uuid::Uuid::new_v4(),
             username: String::new(),
             password: String::new(),
             email: String::new(),

tests/tests.rs

@@ -1,19 +1,13 @@
-mod song_tests {
+mod utils {
     use std::fs;
-    use std::fs::File;
-    use std::io::{Read, Write};
+    use std::io::Read;
     use std::path::Path;
 
-    use tempfile::tempdir;
-
-    use icarus_models::song;
-    use icarus_models::types;
-
-    fn get_tests_directory() -> String {
+    pub fn get_tests_directory() -> String {
         String::from(env!("CARGO_MANIFEST_DIR").to_owned() + "/tests/")
     }
 
-    fn does_directory_exists(directory: &String) -> bool {
+    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()
@@ -22,7 +16,7 @@ mod song_tests {
         }
     }
 
-    fn extract_data_from_file(filepath: &String) -> Result<Vec<u8>, std::io::Error> {
+    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();
@@ -32,6 +26,19 @@ mod song_tests {
             Err(err) => Err(err),
         }
     }
+}
+
+#[cfg(test)]
+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() {
@@ -43,18 +50,18 @@ mod song_tests {
 
         println!("Getting track");
         let mut song = song::Song::default();
-        song.directory = get_tests_directory();
+        song.directory = utils::get_tests_directory();
         song.filename = String::from("track01.flac");
 
         assert!(
-            does_directory_exists(&song.directory),
+            utils::does_directory_exists(&song.directory),
             "Directory does not exist"
         );
 
         println!("Directory: {}", song.directory);
 
         match song.song_path() {
-            Ok(filepath) => match extract_data_from_file(&filepath) {
+            Ok(filepath) => match utils::extract_data_from_file(&filepath) {
                 Ok(buffer) => {
                     assert_eq!(buffer.is_empty(), false);
 
@@ -81,11 +88,11 @@ mod song_tests {
     #[test]
     fn test_song_path_check() {
         let mut song = song::Song::default();
-        song.directory = get_tests_directory();
+        song.directory = utils::get_tests_directory();
         song.filename = String::from("track01.flac");
 
         assert!(
-            does_directory_exists(&song.directory),
+            utils::does_directory_exists(&song.directory),
             "Directory does not exist"
         );
     }
@@ -93,11 +100,11 @@ mod song_tests {
     #[test]
     fn test_song_generate_filename() {
         let mut song = song::Song::default();
-        song.directory = get_tests_directory();
+        song.directory = utils::get_tests_directory();
         song.filename = String::from("track01.flac");
 
         match song.song_path() {
-            Ok(songpath) => match extract_data_from_file(&songpath) {
+            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");
@@ -144,3 +151,31 @@ mod song_tests {
         }
     }
 }
+
+#[cfg(test)]
+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);
+                }
+            }
+        }
+    }
+}