feat: add senses data (range, acuity, vision) (#82)

* add senses data and vision field
* update swagger
* update DB version to download

Makefile.toml

@@ -4,7 +4,7 @@ args = ["clean"]
 
 [tasks.prebuild]
 command = "python3"
-args = ["setup.py", "--db_version", "2.3.0"]
+args = ["setup.py", "--db_version", "2.4.0"]
 
 [tasks.format]
 install_crate = "rustfmt"

setup.py

@@ -25,16 +25,16 @@ def handle_command_line_arguments() -> Optional[str]:
             if currentArgument in ("-h", "--help"):
                 print("This script downloads or creates necessary file to build BYBE. \n"
                       "Should be executed the first time the project is built in the machine or when resetting the database \n"
-                      "Pass the --db_version or -v argument to input a specific BYBE-DB version to download (>= 2.3.0)")
+                      "Pass the --db_version or -d argument to input a specific BYBE-DB version to download (>= 2.3.0)")
             elif currentArgument in ("-d", "--db_version"):
                 return currentValue
     except getopt.error:
         pass
 
 def main():
     # Check if the file already exists or needs downloading
-    db_version: str = handle_command_line_arguments() or "2.3.0"
-    print(db_version)
+    db_version: str = handle_command_line_arguments()
+    print(f"Using DB version: {db_version}") or "2.3.0" # Oldest DB version publicly available
     remote_url: str = f"https://github.com/RakuJa/BYBE-DB/releases/download/v{db_version}/database.db"
     destination_file: str = "database.db"
     if not os.path.exists(destination_file):

src/db/data_providers/creature_fetcher.rs

@@ -23,9 +23,9 @@ use crate::models::creature::items::spell_caster_entry::SpellCasterEntry;
 use crate::models::db::raw_immunity::RawImmunity;
 use crate::models::db::raw_language::RawLanguage;
 use crate::models::db::raw_resistance::RawResistance;
-use crate::models::db::raw_sense::RawSense;
 use crate::models::db::raw_speed::RawSpeed;
 use crate::models::db::raw_weakness::RawWeakness;
+use crate::models::db::sense::Sense;
 use crate::models::item::armor_struct::Armor;
 use crate::models::item::item_struct::Item;
 use crate::models::item::shield_struct::Shield;
@@ -83,10 +83,10 @@ async fn fetch_creature_resistances(
     .await?)
 }
 
-async fn fetch_creature_senses(conn: &Pool<Sqlite>, creature_id: i64) -> Result<Vec<RawSense>> {
+async fn fetch_creature_senses(conn: &Pool<Sqlite>, creature_id: i64) -> Result<Vec<Sense>> {
     Ok(sqlx::query_as!(
-        RawSense,
-        "SELECT * FROM SENSE_TABLE INTERSECT SELECT sense_id FROM SENSE_CREATURE_ASSOCIATION_TABLE WHERE creature_id == ($1)",
+        Sense,
+        "SELECT * FROM SENSE_TABLE WHERE id IN (SELECT sense_id FROM SENSE_CREATURE_ASSOCIATION_TABLE WHERE creature_id == ($1))",
         creature_id
     ).fetch_all(conn).await?)
 }
@@ -188,6 +188,15 @@ async fn fetch_creature_perception(conn: &Pool<Sqlite>, creature_id: i64) -> Res
     )
 }
 
+async fn fetch_creature_vision(conn: &Pool<Sqlite>, creature_id: i64) -> Result<bool> {
+    Ok(
+        sqlx::query_scalar("SELECT vision FROM CREATURE_TABLE WHERE id = $1 LIMIT 1")
+            .bind(creature_id)
+            .fetch_one(conn)
+            .await?,
+    )
+}
+
 async fn fetch_creature_perception_detail(
     conn: &Pool<Sqlite>,
     creature_id: i64,
@@ -577,14 +586,15 @@ pub async fn fetch_creature_extra_data(
     let ac_detail = fetch_creature_ac_detail(conn, creature_id).await?;
     let language_detail = fetch_creature_language_detail(conn, creature_id).await?;
     let perception = fetch_creature_perception(conn, creature_id).await?;
+    let has_vision = fetch_creature_vision(conn, creature_id).await?;
     let perception_detail = fetch_creature_perception_detail(conn, creature_id).await?;
 
     Ok(CreatureExtraData {
         actions,
         skills,
         items,
         languages: languages.iter().map(|x| x.name.clone()).collect(),
-        senses: senses.iter().map(|x| x.name.clone()).collect(),
+        senses,
         speeds: speeds
             .iter()
             .map(|x| (x.name.clone(), x.value as i16))
@@ -595,6 +605,7 @@ pub async fn fetch_creature_extra_data(
         language_detail,
         perception,
         perception_detail,
+        has_vision,
     })
 }
 

src/models/creature/creature_component/creature_extra.rs

@@ -1,6 +1,7 @@
 use crate::models::creature::creature_metadata::variant_enum::CreatureVariant;
 use crate::models::creature::items::action::Action;
 use crate::models::creature::items::skill::Skill;
+use crate::models::db::sense::Sense;
 use crate::models::item::item_struct::Item;
 use serde::{Deserialize, Serialize};
 #[allow(unused_imports)] // it's actually used in the example schema
@@ -30,7 +31,7 @@ pub struct CreatureExtraData {
     pub skills: Vec<Skill>,
     pub items: Vec<Item>,
     pub languages: Vec<String>,
-    pub senses: Vec<String>,
+    pub senses: Vec<Sense>,
     #[schema(example = json!({"fly": 100, "swim": 50, "Base": 25}))]
     pub speeds: BTreeMap<String, i16>,
     pub ability_scores: AbilityScores,
@@ -40,6 +41,7 @@ pub struct CreatureExtraData {
     #[schema(example = 0)]
     pub perception: i8,
     pub perception_detail: Option<String>,
+    pub has_vision: bool,
 }
 
 impl CreatureExtraData {

src/models/db/mod.rs

@@ -1,6 +1,6 @@
 pub mod raw_immunity;
 pub mod raw_language;
 pub mod raw_resistance;
-pub mod raw_sense;
 pub mod raw_speed;
 pub mod raw_weakness;
+pub mod sense;

src/models/db/sense.rs

@@ -0,0 +1,11 @@
+use serde::{Deserialize, Serialize};
+use sqlx::FromRow;
+use utoipa::ToSchema;
+
+#[derive(Serialize, Deserialize, FromRow, ToSchema, Clone, Eq, Hash, PartialEq)]
+pub struct Sense {
+    pub id: i64,
+    pub name: String,
+    pub range: Option<i64>,
+    pub acuity: Option<String>,
+}

src/routes/bestiary.rs

@@ -29,6 +29,7 @@ use crate::models::item::weapon_struct::Weapon;
 
 use crate::models::bestiary_structs::CreatureSortEnum;
 use crate::models::bestiary_structs::{BestiaryPaginatedRequest, BestiarySortData};
+use crate::models::db::sense::Sense;
 use crate::models::routers_validator_structs::{CreatureFieldFilters, PaginatedRequest};
 use crate::services::bestiary_service;
 use crate::services::bestiary_service::BestiaryResponse;
@@ -87,6 +88,7 @@ pub fn init_docs(doc: &mut utoipa::openapi::OpenApi) {
             CreatureExtraData,
             CreatureCombatData,
             CreatureSpellCasterData,
+            Sense,
             Spell,
             Shield,
             Weapon,