Compare commits

..

1 Commits

Author SHA1 Message Date
2b2e96c02d Merge pull request 'devel' (#16) from devel into main
All checks were successful
Rust Build / Check (push) Successful in 26s
Rust Build / Test Suite (push) Successful in 26s
Rust Build / Rustfmt (push) Successful in 26s
Rust Build / Clippy (push) Successful in 26s
Rust Build / build (push) Successful in 26s
Release Tagging / release (push) Successful in 28s
Reviewed-on: phoenix/icarus-models#16
2025-03-22 21:24:15 +00:00
13 changed files with 90 additions and 169 deletions

View File

@@ -3,13 +3,14 @@ name: Release Tagging
on: on:
push: push:
branches: branches:
- main
- devel - devel
tags: tags:
- 'v*' # Trigger on tags matching v* - 'v*' # Trigger on tags matching v*
jobs: jobs:
release: release:
runs-on: ubuntu-24.04 runs-on: ubuntu-latest
steps: steps:
- name: Checkout code - name: Checkout code
uses: actions/checkout@v3 uses: actions/checkout@v3
@@ -19,7 +20,7 @@ jobs:
- name: Install Rust - name: Install Rust
uses: actions-rs/toolchain@v1 uses: actions-rs/toolchain@v1
with: with:
toolchain: 1.86.0 toolchain: 1.85.0
components: cargo components: cargo
- name: Extract Version from Cargo.toml - name: Extract Version from Cargo.toml

View File

@@ -13,54 +13,54 @@ on:
jobs: jobs:
check: check:
name: Check name: Check
runs-on: ubuntu-24.04 runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1 - uses: actions-rust-lang/setup-rust-toolchain@v1
with: with:
toolchain: 1.86.0 toolchain: 1.85.0
- run: cargo check - run: cargo check
test: test:
name: Test Suite name: Test Suite
runs-on: ubuntu-24.04 runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1 - uses: actions-rust-lang/setup-rust-toolchain@v1
with: with:
toolchain: 1.86.0 toolchain: 1.85.0
- run: cargo test - run: cargo test
fmt: fmt:
name: Rustfmt name: Rustfmt
runs-on: ubuntu-24.04 runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1 - uses: actions-rust-lang/setup-rust-toolchain@v1
with: with:
toolchain: 1.86.0 toolchain: 1.85.0
- run: rustup component add rustfmt - run: rustup component add rustfmt
- run: cargo fmt --all -- --check - run: cargo fmt --all -- --check
clippy: clippy:
name: Clippy name: Clippy
runs-on: ubuntu-24.04 runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1 - uses: actions-rust-lang/setup-rust-toolchain@v1
with: with:
toolchain: 1.86.0 toolchain: 1.85.0
- run: rustup component add clippy - run: rustup component add clippy
- run: cargo clippy -- -D warnings - run: cargo clippy -- -D warnings
build: build:
name: build name: build
runs-on: ubuntu-24.04 runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v4 - uses: actions/checkout@v4
- uses: actions-rust-lang/setup-rust-toolchain@v1 - uses: actions-rust-lang/setup-rust-toolchain@v1
with: with:
toolchain: 1.86.0 toolchain: 1.85.0
- run: cargo build - run: cargo build

View File

@@ -1,8 +1,7 @@
[package] [package]
name = "icarus_models" name = "icarus-models"
version = "0.4.0" version = "0.1.14"
edition = "2024" edition = "2024"
rust-version = "1.86"
description = "models used for the icarus project" description = "models used for the icarus project"
license = "MIT" license = "MIT"
@@ -10,7 +9,4 @@ license = "MIT"
serde = { version = "1.0.218", features = ["derive"] } serde = { version = "1.0.218", features = ["derive"] }
serde_json = { version = "1.0.139" } serde_json = { version = "1.0.139" }
rand = { version = "0.9" } rand = { version = "0.9" }
time = { version = "0.3.41", features = ["formatting", "macros", "parsing", "serde"] }
uuid = { version = "1.16.0", features = ["v4", "serde"] }
[dev-dependencies]
tempfile = { version = "3.19.1" } tempfile = { version = "3.19.1" }

View File

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

View File

@@ -5,7 +5,9 @@ pub mod collection {
use std::fs::File; use std::fs::File;
use std::io::BufReader; use std::io::BufReader;
use crate::init; fn is_set(num: &i32) -> bool {
*num >= 0
}
pub fn parse_album(filepath: &String) -> Result<Album, serde_json::Error> { pub fn parse_album(filepath: &String) -> Result<Album, serde_json::Error> {
let file = File::open(filepath).expect("Failed to open file"); let file = File::open(filepath).expect("Failed to open file");
@@ -25,7 +27,7 @@ pub mod collection {
pub genre: String, pub genre: String,
pub year: i32, pub year: i32,
pub track_count: i32, pub track_count: i32,
#[serde(skip_serializing_if = "init::is_set")] #[serde(skip_serializing_if = "is_set")]
pub disc_count: i32, pub disc_count: i32,
#[serde(skip_serializing_if = "Vec::is_empty")] #[serde(skip_serializing_if = "Vec::is_empty")]
pub tracks: Vec<Track>, pub tracks: Vec<Track>,

View File

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

View File

@@ -2,27 +2,14 @@ use std::io::Read;
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
#[derive(Clone, Debug, Default, Deserialize, Serialize)] #[derive(Debug, Clone, Deserialize, Serialize)]
pub struct CoverArt { pub struct CoverArt {
pub id: uuid::Uuid, pub id: i32,
pub title: String, pub title: String,
pub path: String, pub path: String,
pub data: Vec<u8>, 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 { impl CoverArt {
pub fn to_data(&self) -> Result<Vec<u8>, std::io::Error> { pub fn to_data(&self) -> Result<Vec<u8>, std::io::Error> {
let path: &String = &self.path; let path: &String = &self.path;
@@ -34,16 +21,3 @@ 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);
}
}

View File

@@ -7,25 +7,3 @@ pub mod song;
pub mod token; pub mod token;
pub mod types; pub mod types;
pub mod user; 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
}
}

View File

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

View File

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

View File

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

View File

@@ -1,13 +1,11 @@
use std::default::Default; use std::default::Default;
use crate::init;
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
#[derive(Clone, Debug, Deserialize, Serialize)] #[derive(Clone, Debug, Deserialize, Serialize)]
pub struct User { pub struct User {
#[serde(skip_serializing_if = "init::is_uuid_nil")] #[serde(skip_serializing_if = "is_id_valid")]
pub id: uuid::Uuid, pub id: i32,
#[serde(skip_serializing_if = "String::is_empty")] #[serde(skip_serializing_if = "String::is_empty")]
pub username: String, pub username: String,
#[serde(skip_serializing_if = "String::is_empty")] #[serde(skip_serializing_if = "String::is_empty")]
@@ -21,20 +19,22 @@ pub struct User {
#[serde(skip_serializing_if = "String::is_empty")] #[serde(skip_serializing_if = "String::is_empty")]
pub lastname: String, pub lastname: String,
pub email_verified: bool, pub email_verified: bool,
#[serde(with = "time::serde::rfc3339::option")] #[serde(skip_serializing_if = "String::is_empty")]
pub date_created: Option<time::OffsetDateTime>, pub date_created: String,
#[serde(skip_serializing_if = "String::is_empty")] #[serde(skip_serializing_if = "String::is_empty")]
pub status: String, pub status: String,
#[serde(with = "time::serde::rfc3339::option")] #[serde(skip_serializing_if = "String::is_empty")]
pub last_login: Option<time::OffsetDateTime>, pub last_login: String,
#[serde(skip_serializing_if = "init::is_uuid_nil")] }
pub salt_id: uuid::Uuid,
fn is_id_valid(num: &i32) -> bool {
*num > 0
} }
impl Default for User { impl Default for User {
fn default() -> Self { fn default() -> Self {
User { User {
id: uuid::Uuid::new_v4(), id: -1,
username: String::new(), username: String::new(),
password: String::new(), password: String::new(),
email: String::new(), email: String::new(),
@@ -42,10 +42,9 @@ impl Default for User {
firstname: String::new(), firstname: String::new(),
lastname: String::new(), lastname: String::new(),
email_verified: false, email_verified: false,
date_created: None, date_created: String::new(),
status: String::new(), status: String::new(),
last_login: None, last_login: String::new(),
salt_id: uuid::Uuid::nil(),
} }
} }
} }
@@ -59,29 +58,3 @@ impl User {
} }
} }
} }
pub mod salt {
use std::default::Default;
use crate::init;
use serde::{Deserialize, Serialize};
#[derive(Clone, Debug, Default, Deserialize, Serialize)]
pub struct Salt {
#[serde(skip_serializing_if = "init::is_uuid_nil")]
pub id: uuid::Uuid,
#[serde(skip_serializing_if = "String::is_empty")]
pub salt: String,
}
impl Salt {
pub fn to_json(&self, output_pretty: bool) -> Result<String, serde_json::Error> {
if output_pretty {
serde_json::to_string_pretty(&self)
} else {
serde_json::to_string(&self)
}
}
}
}

View File

@@ -28,7 +28,6 @@ mod utils {
} }
} }
#[cfg(test)]
mod song_tests { mod song_tests {
use std::fs::File; use std::fs::File;
use std::io::Write; use std::io::Write;
@@ -152,7 +151,6 @@ mod song_tests {
} }
} }
#[cfg(test)]
mod album_tests { mod album_tests {
use crate::utils; use crate::utils;