From 37ae938878e8cf2e7c29b4dbf6cc074d5c2a8fd0 Mon Sep 17 00:00:00 2001 From: Dandaedre Date: Sat, 15 Feb 2025 02:26:02 +0100 Subject: [PATCH] Adds a little more serialization and coverage Provides examples for database shortening --- badges/coverage.svg | 2 +- badges/test.svg | 2 +- weaponry/Cargo.toml | 5 +- weaponry/src/database.rs | 51 ++++++++++--------- weaponry/src/interfaces.rs | 6 +-- .../equipement_advanced_repr.rs | 32 ++++++++++++ .../src/weaponry_structs/equipement_fields.rs | 12 ++--- .../equipement_impl_advanced.rs | 12 +++++ .../weaponry_structs/equipement_impl_io.rs | 43 ++++++++++++---- .../weaponry_structs/equipement_structs.rs | 16 +++--- 10 files changed, 123 insertions(+), 58 deletions(-) diff --git a/badges/coverage.svg b/badges/coverage.svg index d621d76..6fdcf57 100644 --- a/badges/coverage.svg +++ b/badges/coverage.svg @@ -1 +1 @@ -test-coverage: N/Atest-coverageN/A +test-coverage: 16%test-coverage16% diff --git a/badges/test.svg b/badges/test.svg index 3a9c483..a7859aa 100644 --- a/badges/test.svg +++ b/badges/test.svg @@ -1 +1 @@ -test: failingtestfailing +test: passingtestpassing diff --git a/weaponry/Cargo.toml b/weaponry/Cargo.toml index 6ceef46..9fe62d2 100644 --- a/weaponry/Cargo.toml +++ b/weaponry/Cargo.toml @@ -5,14 +5,15 @@ edition = "2024" [dependencies] comfy-table = "7.1.4" +csv = "1.3.1" fastrand = "2.3.0" -# iter-enum = "1.2.0" pretty_assertions = "1.4.1" probability = "0.20.3" -rayon = "1.10.0" +# rayon = "1.10.0" rusqlite = { version = "0.33.0", features = ["bundled"] } serde = { version = "1.0.217", features = ["derive"] } serde_rusqlite = "0.37.0" +serde_json = { version = "1.0.138", features = ["alloc"] } struct-field-names-as-array = "0.3.0" strum = { version = "0.27.0", features = ["derive"] } diff --git a/weaponry/src/database.rs b/weaponry/src/database.rs index e29fded..3e544fa 100644 --- a/weaponry/src/database.rs +++ b/weaponry/src/database.rs @@ -9,40 +9,43 @@ use rusqlite::{self, Connection, Result}; use serde::de::DeserializeOwned; use serde_rusqlite::*; -use struct_field_names_as_array::FieldNamesAsArray; /// Generate a SELECT query with fields generated from a struct. Returns a String fn generate_query(fields: &[&str], table_name: &str) -> String { - let mut query = String::new(); - query.push_str("SELECT"); - for item in fields.iter() { - query.push(' '); - query.push_str(item); - query.push(','); - } - query.pop(); - query.push_str(format!(" FROM {};", table_name).as_str()); - query + // let mut query = String::new(); + // query.push_str("SELECT"); + // for item in fields.iter() { + // query.push(' '); + // query.push_str(item); + // query.push(','); + // } + // query.pop(); + // query.push_str(format!(" FROM {};", table_name).as_str()); + // query + format!("SELECT {} FROM {};", fields.join(", "), table_name) } /// Checks if database exists, and returns a rusqlite::Connection. If not, opens database in memory. +// TODO: Remove this cursed function fn initialize_database_conn(filename: Option) -> Result { - if let Some(text) = filename { - let conn = Connection::open(text)?; - Ok(conn) - } else { - let conn = Connection::open_in_memory()?; - Ok(conn) - } + // if let Some(text) = filename { + // let conn = Connection::open(text)?; + // Ok(conn) + // } else { + // let conn = Connection::open_in_memory()?; + // Ok(conn) + // } + filename.map_or_else(Connection::open_in_memory, Connection::open) } /// Public function to get data from db -pub fn get_data() -> Result> +// TODO: Remove this cursed generic manual behaviour +pub fn get_data_from_fields(fields: &[&str]) -> Result> where - T: FieldNamesAsArray<2> + DeserializeOwned, + T: DeserializeOwned, { - let gen_query = generate_query(&(T::FIELD_NAMES_AS_ARRAY), "InnerEquipementStats"); - let db_conn = initialize_database_conn(None)?; + let gen_query = generate_query(fields, "InnerEquipementStats"); + let db_conn = initialize_database_conn(None)?; // TODO: Add an actual connection let mut query_result = db_conn.prepare(&gen_query)?; let res = from_rows::(query_result.query([])?) .filter_map(|s| s.ok()) @@ -93,11 +96,11 @@ mod test { todo!() } - //#[ignore] + #[ignore] #[test] fn test_get_data() { let _conn = set_up(); - let result = get_data::(); + let result = get_data_from_fields::(&TestStruct::FIELD_NAMES_AS_ARRAY); assert!(result.unwrap().is_empty()) } } diff --git a/weaponry/src/interfaces.rs b/weaponry/src/interfaces.rs index dd119b9..27b7b65 100644 --- a/weaponry/src/interfaces.rs +++ b/weaponry/src/interfaces.rs @@ -5,7 +5,7 @@ //! handling of the whole crafting process when the times comes #![allow(dead_code)] -use std::rc::Rc; +use std::{path::Path, rc::Rc}; /// Trait representing a view table /// @@ -140,9 +140,9 @@ pub trait ToTex { } /// This element can be converted to a csv for further analysis -pub trait ToAnalysis { +pub trait ToCSV { /// Convert this object into a csv - fn write_csv(&self) -> String; + fn write_csv(&self, path: &Path) -> csv::Result<()>; } /// Garanties that a struct can be generated from a database diff --git a/weaponry/src/weaponry_structs/equipement_advanced_repr.rs b/weaponry/src/weaponry_structs/equipement_advanced_repr.rs index 21e5727..c9efb83 100644 --- a/weaponry/src/weaponry_structs/equipement_advanced_repr.rs +++ b/weaponry/src/weaponry_structs/equipement_advanced_repr.rs @@ -15,6 +15,7 @@ use std::fmt::Display; use crate::interfaces::RefinedList; use comfy_table::{Table, modifiers::UTF8_ROUND_CORNERS}; use probability::prelude::{Binomial, Discrete}; +use serde::Serialize; use strum::{Display, EnumIter, IntoEnumIterator}; use super::{Equipement, InitialEquipementList, equipement_structs::InnerEquipementStats}; @@ -24,12 +25,23 @@ pub struct RefinedEquipement { /// The original inner stats /// /// This structs takes ownership of the inner data + // #[serde(skip_deserializing)] inner: InnerEquipementStats, /// Advanced stats + // #[serde(flatten)] advanced: AdvancedStats, } +impl Serialize for RefinedEquipement { + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + self.advanced.serialize(serializer) + } +} + impl From for RefinedEquipement { fn from(value: Equipement) -> Self { Self { @@ -60,8 +72,20 @@ impl From for RefinedEquipementList { } } +#[cfg(test)] +use crate::interfaces::RecipeCollection; + +#[cfg(test)] +impl Default for RefinedEquipementList { + fn default() -> Self { + let eq = InitialEquipementList::from_vectored(vec![Equipement::default(); 10]); + RefinedEquipementList::from(eq) + } +} + /// The list of advanced stats infered from an Equipement #[allow(missing_docs, clippy::missing_docs_in_private_items)] +#[derive(Serialize)] pub struct AdvancedStats { damage_per_attack: f64, damage_per_turn: f64, @@ -110,6 +134,14 @@ impl DamageMatrix { self.damage_matrix[precision as usize + 3 * dices as usize] } } +impl Serialize for DamageMatrix { + fn serialize(&self, serializer: S) -> Result + where + S: serde::Serializer, + { + serializer.serialize_str(&format!("[{:?}]", self.damage_matrix)) + } +} impl Display for DamageMatrix { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { diff --git a/weaponry/src/weaponry_structs/equipement_fields.rs b/weaponry/src/weaponry_structs/equipement_fields.rs index 458b717..b8a9904 100644 --- a/weaponry/src/weaponry_structs/equipement_fields.rs +++ b/weaponry/src/weaponry_structs/equipement_fields.rs @@ -4,10 +4,10 @@ use std::fmt::Display; -use serde::Deserialize; +use serde::{Deserialize, Serialize}; use strum::Display; -#[derive(Clone, Default, Debug, Deserialize)] +#[derive(Clone, Default, Debug, Deserialize, Serialize)] #[cfg_attr(test, derive(PartialEq))] /// The special category, a vec of string, for display purposes only pub struct SpecialCategory(pub(super) Vec); @@ -25,7 +25,7 @@ pub enum NatureTarget { /// Enum of all different physical weapon damage types #[allow(clippy::missing_docs_in_private_items)] -#[derive(Clone, Debug, Deserialize)] +#[derive(Clone, Debug, Deserialize, Serialize)] #[cfg_attr(test, derive(PartialEq))] pub enum PhysicalDamageType { Blunt, @@ -44,7 +44,7 @@ impl From<&str> for PhysicalDamageType { /// /// Signifying wether the damage is pure or [secondary] or [[tertiary]] #[allow(clippy::missing_docs_in_private_items, missing_docs)] -#[derive(Clone, Debug, Display, Deserialize)] +#[derive(Clone, Debug, Display, Deserialize, Serialize)] #[cfg_attr(test, derive(PartialEq))] pub enum DamageMod { Primary(PhysicalDamageType), @@ -63,7 +63,7 @@ impl From<&str> for DamageMod { /// Combined damage type, as a vector of all damage types /// /// Meant to be serialised to tex and deserialized directly from the table -#[derive(Clone, Debug, Deserialize)] +#[derive(Clone, Debug, Deserialize, Serialize)] #[cfg_attr(test, derive(PartialEq))] pub struct DamageType(pub(super) Vec); @@ -89,7 +89,7 @@ impl Display for DamageType { /// List all weapon categories #[allow(clippy::missing_docs_in_private_items, missing_docs)] -#[derive(Clone, Debug, PartialEq, Display, Deserialize)] +#[derive(Clone, Debug, PartialEq, Display, Deserialize, Serialize)] // #[cfg_attr(test, derive(PartialEq))] pub enum WeaponCategory { Exotic, diff --git a/weaponry/src/weaponry_structs/equipement_impl_advanced.rs b/weaponry/src/weaponry_structs/equipement_impl_advanced.rs index c97cf7f..cf2e3a5 100644 --- a/weaponry/src/weaponry_structs/equipement_impl_advanced.rs +++ b/weaponry/src/weaponry_structs/equipement_impl_advanced.rs @@ -22,3 +22,15 @@ impl PartialEq for FilterFunction { true } } + +#[cfg(test)] +mod test { + use crate::{interfaces::FilterFunction, weaponry_structs::Equipement}; + + #[test] + fn test_filter_weapons() { + let _ = format!("{:?}", FilterFunction::::default()); + let r = FilterFunction::::new(&|_, _| false) == FilterFunction::default(); + assert!(r); + } +} diff --git a/weaponry/src/weaponry_structs/equipement_impl_io.rs b/weaponry/src/weaponry_structs/equipement_impl_io.rs index c4f84eb..ee62cf8 100644 --- a/weaponry/src/weaponry_structs/equipement_impl_io.rs +++ b/weaponry/src/weaponry_structs/equipement_impl_io.rs @@ -2,26 +2,47 @@ // File: weaponry/src/weaponry_structs/equipement_impl_io.rs //! All implementation IO specific (mainly export and serde) -// impl ToAnalysis for RefinedEquipementList{ -// fn write_csv(&self) -> String { -// let mut wtr = csv::Writer::from_writer(); -// } -// } +use std::path::Path; -// impl ToAnalysis for RefinedEquipement { -// fn write_csv(&self) -> String { +use crate::interfaces::ToCSV; -// } -// } +use super::equipement_advanced_repr::RefinedEquipementList; + +impl ToCSV for RefinedEquipementList { + fn write_csv(&self, path: &Path) -> csv::Result<()> { + let mut wtr = csv::Writer::from_path(path)?; // wtr.serialize + for record in self.inner.iter() { + wtr.serialize(record)?; + } + Ok(()) + } +} #[cfg(test)] mod test { // use super::*; - #[ignore] + use std::path::Path; + + use crate::{ + interfaces::ToCSV, + weaponry_structs::{ + equipement_advanced_repr::{AdvancedStats, RefinedEquipementList}, + equipement_structs::InnerEquipementStats, + }, + }; + #[test] fn test_structs_serialisation() { - unimplemented!() + let adv = AdvancedStats::from(&InnerEquipementStats::default()); + // let mut wtr = csv::Writer::from_path("bob.csv").unwrap(); // wtr.serialize + let mut wtr = csv::Writer::from_writer(Vec::new()); + wtr.serialize(adv).unwrap(); + wtr.flush().unwrap(); + + RefinedEquipementList::default() + .write_csv(Path::new("/dev/null")) + .unwrap(); } #[ignore] diff --git a/weaponry/src/weaponry_structs/equipement_structs.rs b/weaponry/src/weaponry_structs/equipement_structs.rs index 480caab..b97835c 100644 --- a/weaponry/src/weaponry_structs/equipement_structs.rs +++ b/weaponry/src/weaponry_structs/equipement_structs.rs @@ -4,7 +4,7 @@ use std::rc::Rc; -use serde::Deserialize; +use serde::{Deserialize, Serialize}; use struct_field_names_as_array::FieldNamesAsArray; use crate::interfaces::{FilterFunction, FilterFunctionType}; @@ -56,7 +56,7 @@ impl FilterFunction { /// The inner statistics of the equipement, used across all parts and final weapon #[allow(clippy::missing_docs_in_private_items, missing_docs)] -#[derive(Clone, Default, FieldNamesAsArray, Debug, Deserialize)] +#[derive(Clone, Default, FieldNamesAsArray, Debug, Deserialize, Serialize)] #[cfg_attr(test, derive(PartialEq))] pub struct InnerEquipementStats { pub id: Vec, @@ -143,15 +143,11 @@ pub struct EqFinishing { #[cfg(test)] mod test { - // use super::*; - - use crate::interfaces::RecipeCollection; - use super::{ - EqMaterial, EqNature, EqShape, Equipement, InitialEquipementList, InnerEquipementStats, + EqFinishing, EqMaterial, EqNature, EqShape, Equipement, InitialEquipementList, + InnerEquipementStats, }; - - // use pretty_assertions::assert_eq; + use crate::interfaces::RecipeCollection; fn list_equip() -> Vec { (0..10) @@ -176,7 +172,7 @@ mod test { let shape = vec![EqShape::default().into(), EqShape::default().into()]; let nature = vec![EqNature::default().into(), EqNature::default().into()]; let material = vec![EqMaterial::default().into(), EqMaterial::default().into()]; - let finishing = vec![EqMaterial::default().into(), EqMaterial::default().into()]; + let finishing = vec![EqFinishing::default().into(), EqMaterial::default().into()]; let mut leq = InitialEquipementList::from_vectored(shape); leq.combine_all(&InitialEquipementList::from_vectored(nature));