Version bump (#22)

v0.1.16

Reviewed-on: phoenix/icarus-models#22
Co-authored-by: KD <kundeng94@gmail.com>
Co-committed-by: KD <kundeng94@gmail.com>

.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"
+name = "icarus_models"
-version = "0.1.14"
+version = "0.2.0"
 edition = "2024"
 description = "models used for the icarus project"
 license = "MIT"

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 mod file_extensions {
-pub const FLACEXTENSION: &str = ".flac";
+    pub mod audio {
-pub const WAVEXTENSION: &str = ".wav";
+        pub const DEFAULTMUSICEXTENSION: &str = FLACEXTENSION;
-pub const MPTHREEEXTENSION: &str = ".mp3";
+        pub const FLACEXTENSION: &str = ".flac";
-pub const JPGEXTENSION: &str = ".jpg";
+        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/song.rs

@@ -128,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::WavExtension => {
-            types::MusicTypes::FlacExtension => String::from(constants::FLACEXTENSION),
+                String::from(constants::file_extensions::audio::WAVEXTENSION)
-            types::MusicTypes::MPThreeExtension => String::from(constants::MPTHREEEXTENSION),
+            }
+            types::MusicTypes::FlacExtension => {
+                String::from(constants::file_extensions::audio::FLACEXTENSION)
+            }
+            types::MusicTypes::MPThreeExtension => {
+                String::from(constants::file_extensions::audio::MPTHREEEXTENSION)
+            }
         };
 
         if randomize {

tests/tests.rs

@@ -1,19 +1,13 @@
-mod song_tests {
+mod utils {
     use std::fs;
-    use std::fs::File;
+    use std::io::Read;
-    use std::io::{Read, Write};
     use std::path::Path;
 
-    use tempfile::tempdir;
+    pub fn get_tests_directory() -> String {
-
-    use icarus_models::song;
-    use icarus_models::types;
-
-    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,18 @@ mod song_tests {
             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() {
@@ -43,18 +49,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 +87,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 +99,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 +150,30 @@ mod song_tests {
         }
     }
 }
+
+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);
+                }
+            }
+        }
+    }
+}