Huge refactor for database functions

This commit is contained in:
Frédéric CAMPO 2025-02-17 23:17:46 +01:00
parent 27a9f1cb5c
commit ece331b2b2
Signed by: llowin
GPG Key ID: 19EACF0560706F99
6 changed files with 72 additions and 67 deletions

View File

@ -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<T>(
&self,
fields: &[&str],
table_name: &str,
) -> Result<Vec<T>, serde_rusqlite::Error>
where
T: DeserializeOwned,
{
let mut query_result = self.conn.prepare(&generate_query(fields, table_name))?;
Ok(serde_rusqlite::from_rows::<T>(query_result.query([])?)
.filter_map(|s| s.ok())
.collect())
}
}
impl RecipeDatabase for EquipementDatabase {
fn serialize_vec_from_table<T: DeserializeOwned>(
table: &str,
) -> Result<Vec<T>, crate::error::FatalEquipementError> {
todo!()
}
fn serialize_vec_from_table_with_query<T: DeserializeOwned>(
table: &str,
query: &str,
) -> Result<Vec<T>, crate::error::FatalEquipementError> {
todo!()
}
/// Checks if database exists, and returns a rusqlite::Connection. If not, opens database in memory.
fn new(filename: &str) -> Result<Self, FatalEquipementError> {
Ok(EquipementDatabase {
conn: Connection::open(filename)?,
})
}
fn initialize_empty_table<T>(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<T>(
conn: &rusqlite::Connection,
fields: &[&str],
table_name: &str,
) -> Result<Vec<T>, serde_rusqlite::Error>
where
T: DeserializeOwned,
{
let mut query_result = conn.prepare(&generate_select_query(fields, table_name, None))?;
Ok(serde_rusqlite::from_rows::<T>(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>(&TestStruct::FIELD_NAMES_AS_ARRAY, "TestStruct")
.serialize_vec_from_table::<TestStruct>("TestStruct", &TestStruct::FIELD_NAMES_AS_ARRAY)
.unwrap();
tear_down(filename, conn.conn);
assert_eq!(

View File

@ -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)]

View File

@ -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<T: DeserializeOwned>(
&self,
table: &str,
fields: &[&str],
) -> std::result::Result<Vec<T>, FatalEquipementError>;
/// Serialize a specified vector of objects of the given type with an additionnal restriction
fn serialize_vec_from_table_with_query<T: DeserializeOwned>(
&self,
table: &str,
fields: &[&str],
query: &str,
) -> std::result::Result<Vec<T>, FatalEquipementError>;

View File

@ -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<T: DeserializeOwned>(
&self,
table: &str,
fields: &[&str],
) -> Result<Vec<T>, crate::error::FatalEquipementError> {
Ok(get_data(&self.conn, fields, table)?)
}
fn serialize_vec_from_table_with_query<T: DeserializeOwned>(
&self,
table: &str,
fields: &[&str],
query: &str,
) -> Result<Vec<T>, crate::error::FatalEquipementError> {
todo!()
}
/// Checks if database exists, and returns a rusqlite::Connection. If not, opens database in memory.
fn new(filename: &str) -> Result<Self, FatalEquipementError> {
Ok(EquipementDatabase {
conn: Connection::open(filename)?,
})
}
fn initialize_empty_table<T>(table: &str) -> Result<(), crate::error::EquipementError> {
todo!()
}
}

View File

@ -17,14 +17,18 @@ use super::equipement_advanced_repr::RefinedEquipementList;
pub struct DatabaseMock {}
impl RecipeDatabase for DatabaseMock {
fn serialize_vec_from_table<T>(
&self,
table: &str,
fields: &[&str],
) -> std::result::Result<Vec<T>, crate::error::FatalEquipementError> {
let _ = table;
todo!()
}
fn serialize_vec_from_table_with_query<T>(
&self,
table: &str,
fields: &[&str],
query: &str,
) -> std::result::Result<Vec<T>, crate::error::FatalEquipementError> {
let _ = table;

View File

@ -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;