From ece331b2b2e0e95135514ea94c3abcfd007cb310 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fr=C3=A9d=C3=A9ric=20CAMPO?= Date: Mon, 17 Feb 2025 23:17:46 +0100 Subject: [PATCH] Huge refactor for database functions --- weaponry/src/database.rs | 86 +++++-------------- weaponry/src/error.rs | 2 + weaponry/src/interfaces.rs | 4 + .../equipement_impl_database.rs | 41 +++++++++ .../weaponry_structs/equipement_scenario.rs | 4 + weaponry/src/weaponry_structs/mod.rs | 2 +- 6 files changed, 72 insertions(+), 67 deletions(-) diff --git a/weaponry/src/database.rs b/weaponry/src/database.rs index 33e4597..754e98a 100644 --- a/weaponry/src/database.rs +++ b/weaponry/src/database.rs @@ -3,70 +3,36 @@ //! Database handiling module //! Implements the basics deserialisation from a database to the weaponry components //! Should dump whole database in a vec of structs from weaponry_structs -#![allow(dead_code)] - -use crate::{error::FatalEquipementError, interfaces::RecipeDatabase}; -use rusqlite::{self, Connection}; +use rusqlite::{self}; use serde::de::DeserializeOwned; -/// Struct for database connection. -pub struct EquipementDatabase { - /// Connection parameter for rusqlite - pub conn: rusqlite::Connection, -} - -impl EquipementDatabase { - /// Public function to get data from db. Returns the result as a vec with structs - pub fn get_data_from_fields( - &self, - fields: &[&str], - table_name: &str, - ) -> Result, serde_rusqlite::Error> - where - T: DeserializeOwned, - { - let mut query_result = self.conn.prepare(&generate_query(fields, table_name))?; - Ok(serde_rusqlite::from_rows::(query_result.query([])?) - .filter_map(|s| s.ok()) - .collect()) - } -} - -impl RecipeDatabase for EquipementDatabase { - fn serialize_vec_from_table( - table: &str, - ) -> Result, crate::error::FatalEquipementError> { - todo!() - } - - fn serialize_vec_from_table_with_query( - table: &str, - query: &str, - ) -> Result, crate::error::FatalEquipementError> { - todo!() - } - - /// Checks if database exists, and returns a rusqlite::Connection. If not, opens database in memory. - fn new(filename: &str) -> Result { - Ok(EquipementDatabase { - conn: Connection::open(filename)?, - }) - } - - fn initialize_empty_table(table: &str) -> Result<(), crate::error::EquipementError> { - todo!() - } +/// Public function to get data from db. Returns the result as a vec with structs +pub fn get_data( + conn: &rusqlite::Connection, + fields: &[&str], + table_name: &str, +) -> Result, serde_rusqlite::Error> +where + T: DeserializeOwned, +{ + let mut query_result = conn.prepare(&generate_select_query(fields, table_name, None))?; + Ok(serde_rusqlite::from_rows::(query_result.query([])?) + .filter_map(|s| s.ok()) + .collect()) } /// Generate a SELECT query with fields generated from a struct. Returns a String #[inline] -fn generate_query(fields: &[&str], table_name: &str) -> String { +fn generate_select_query(fields: &[&str], table_name: &str, filter: Option<&str>) -> String { format!("SELECT {} FROM {};", fields.join(", "), table_name) } #[cfg(test)] mod test { use super::*; + use crate::{ + interfaces::RecipeDatabase, weaponry_structs::equipement_impl_database::EquipementDatabase, + }; use pretty_assertions::assert_eq; use serde::Deserialize; use struct_field_names_as_array::FieldNamesAsArray; @@ -98,29 +64,17 @@ mod test { #[test] fn test_generate_query() { assert_eq!( - generate_query(&TestStruct::FIELD_NAMES_AS_ARRAY, "TestStruct"), + generate_select_query(&TestStruct::FIELD_NAMES_AS_ARRAY, "TestStruct", None), "SELECT id, name FROM TestStruct;" ) } - #[ignore] - #[test] - fn test_initialize_database_conn() { - todo!() - } - - #[ignore] - #[test] - fn test_generate_table_from_struct() { - todo!() - } - #[test] fn get_data_from_fields() { let filename = "test.db"; let conn = mock_set_up(filename); let result = conn - .get_data_from_fields::(&TestStruct::FIELD_NAMES_AS_ARRAY, "TestStruct") + .serialize_vec_from_table::("TestStruct", &TestStruct::FIELD_NAMES_AS_ARRAY) .unwrap(); tear_down(filename, conn.conn); assert_eq!( diff --git a/weaponry/src/error.rs b/weaponry/src/error.rs index 9465967..eb1471c 100644 --- a/weaponry/src/error.rs +++ b/weaponry/src/error.rs @@ -10,6 +10,8 @@ use thiserror::Error; pub enum FatalEquipementError { #[error("Rusqlite failed to connect to the given path {0}")] RusqliteConnection(#[from] rusqlite::Error), + #[error("Deserialization from object : {0}")] + SerdeRusqlite(#[from] serde_rusqlite::Error), } #[derive(Error, Debug)] diff --git a/weaponry/src/interfaces.rs b/weaponry/src/interfaces.rs index b08ecc1..82a781b 100644 --- a/weaponry/src/interfaces.rs +++ b/weaponry/src/interfaces.rs @@ -165,12 +165,16 @@ pub trait RecipeDatabase { /// Serialize a vector of objects of the given type in the specified table of the underlying database fn serialize_vec_from_table( + &self, table: &str, + fields: &[&str], ) -> std::result::Result, FatalEquipementError>; /// Serialize a specified vector of objects of the given type with an additionnal restriction fn serialize_vec_from_table_with_query( + &self, table: &str, + fields: &[&str], query: &str, ) -> std::result::Result, FatalEquipementError>; diff --git a/weaponry/src/weaponry_structs/equipement_impl_database.rs b/weaponry/src/weaponry_structs/equipement_impl_database.rs index 5e60565..efbb39a 100644 --- a/weaponry/src/weaponry_structs/equipement_impl_database.rs +++ b/weaponry/src/weaponry_structs/equipement_impl_database.rs @@ -7,3 +7,44 @@ // use super::equipement_structs::{EqFinishing, EqMaterial, EqNature, EqShape}; // TODO: Migrate from database to here +use crate::database::get_data; +use crate::error::FatalEquipementError; +use crate::interfaces::RecipeDatabase; +use rusqlite::Connection; +use serde::de::DeserializeOwned; + +/// Struct for database connection. +pub struct EquipementDatabase { + /// Connection parameter for rusqlite + pub conn: rusqlite::Connection, +} + +impl RecipeDatabase for EquipementDatabase { + fn serialize_vec_from_table( + &self, + table: &str, + fields: &[&str], + ) -> Result, crate::error::FatalEquipementError> { + Ok(get_data(&self.conn, fields, table)?) + } + + fn serialize_vec_from_table_with_query( + &self, + table: &str, + fields: &[&str], + query: &str, + ) -> Result, crate::error::FatalEquipementError> { + todo!() + } + + /// Checks if database exists, and returns a rusqlite::Connection. If not, opens database in memory. + fn new(filename: &str) -> Result { + Ok(EquipementDatabase { + conn: Connection::open(filename)?, + }) + } + + fn initialize_empty_table(table: &str) -> Result<(), crate::error::EquipementError> { + todo!() + } +} diff --git a/weaponry/src/weaponry_structs/equipement_scenario.rs b/weaponry/src/weaponry_structs/equipement_scenario.rs index 2998561..f0116f6 100644 --- a/weaponry/src/weaponry_structs/equipement_scenario.rs +++ b/weaponry/src/weaponry_structs/equipement_scenario.rs @@ -17,14 +17,18 @@ use super::equipement_advanced_repr::RefinedEquipementList; pub struct DatabaseMock {} impl RecipeDatabase for DatabaseMock { fn serialize_vec_from_table( + &self, table: &str, + fields: &[&str], ) -> std::result::Result, crate::error::FatalEquipementError> { let _ = table; todo!() } fn serialize_vec_from_table_with_query( + &self, table: &str, + fields: &[&str], query: &str, ) -> std::result::Result, crate::error::FatalEquipementError> { let _ = table; diff --git a/weaponry/src/weaponry_structs/mod.rs b/weaponry/src/weaponry_structs/mod.rs index f702895..7208fd6 100644 --- a/weaponry/src/weaponry_structs/mod.rs +++ b/weaponry/src/weaponry_structs/mod.rs @@ -19,7 +19,7 @@ mod equipement_advanced_repr; mod equipement_fields; mod equipement_impl_advanced; mod equipement_impl_basics; -mod equipement_impl_database; +pub mod equipement_impl_database; mod equipement_impl_io; mod equipement_impl_logic; mod equipement_impl_math;