feat: add well_purposes and well_casing_materials to thing model

Author: jacob-a-brown

api/search.py

@@ -27,6 +27,8 @@
     Phone,
     Address,
     Thing,
+    WellCasingMaterial,
+    WellPurpose,
     Asset,
     AssetThingAssociation,
     search,
@@ -70,15 +72,28 @@ def _get_contact_results(session: Session, q: str, limit: int) -> list[dict]:
 
 
 def _get_thing_results(session: Session, q: str, limit: int) -> list[dict]:
-    vector = Thing.search_vector
+    well_vector = (
+        func.coalesce(Thing.search_vector, text("''::tsvector"))
+        .op("||")(func.coalesce(WellCasingMaterial.search_vector, text("''::tsvector")))
+        .op("||")(func.coalesce(WellPurpose.search_vector, text("''::tsvector")))
+    )
+
     water_well_query = search(
-        select(Thing).where(Thing.thing_type == "water well"),
+        select(Thing)
+        .outerjoin(WellCasingMaterial)
+        .outerjoin(WellPurpose)
+        .where(Thing.thing_type == "water well"),
         q,
-        vector=vector,
+        vector=well_vector,
         limit=limit,
     )
+
+    spring_vector = Thing.search_vector
     spring_well_query = search(
-        select(Thing).where(Thing.thing_type == "spring"), q, vector=vector, limit=limit
+        select(Thing).where(Thing.thing_type == "spring"),
+        q,
+        vector=spring_vector,
+        limit=limit,
     )
 
     # unique needs to be called because of eager loads

db/thing.py

@@ -98,10 +98,6 @@ class Thing(Base, AutoBaseMixin, ReleaseMixin, StatusHistoryMixin, PermissionMix
         info={"unit": "feet below ground surface"},
         comment="Depth of the well casing from ground surface to the bottom of the casing (in feet).",
     )
-    well_casing_material: Mapped[str] = lexicon_term(
-        nullable=True,
-        comment="Material of the well casing (e.g., 'PVC', 'Steel', 'Concrete', 'Wood').",
-    )
 
     well_construction_notes: Mapped[str] = mapped_column(Text, nullable=True)
 
@@ -211,6 +207,22 @@ class Thing(Base, AutoBaseMixin, ReleaseMixin, StatusHistoryMixin, PermissionMix
         passive_deletes=True,
     )
 
+    well_purposes: Mapped[List["WellPurpose"]] = relationship(
+        "WellPurpose",
+        back_populates="thing",
+        cascade="all, delete-orphan",
+        passive_deletes=True,
+        lazy="joined",
+    )
+
+    well_casing_materials: Mapped[List["WellCasingMaterial"]] = relationship(
+        "WellCasingMaterial",
+        back_populates="thing",
+        cascade="all, delete-orphan",
+        passive_deletes=True,
+        lazy="joined",
+    )
+
     # --- Association Proxies ---
     assets: AssociationProxy[list["Asset"]] = association_proxy(
         "asset_associations", "asset"
@@ -237,11 +249,7 @@ class Thing(Base, AutoBaseMixin, ReleaseMixin, StatusHistoryMixin, PermissionMix
     )
 
     # Full-text search vector
-    search_vector = Column(
-        TSVectorType(
-            "name", "well_construction_notes", "well_purpose", "well_casing_material"
-        )
-    )
+    search_vector = Column(TSVectorType("name", "well_construction_notes"))
 
     @property
     def current_location(self):
@@ -302,6 +310,39 @@ class WellScreen(Base, AutoBaseMixin, ReleaseMixin):
     thing: Mapped["Thing"] = relationship("Thing", back_populates="screens")
 
 
+class WellPurpose(Base, AutoBaseMixin, ReleaseMixin):
+    """
+    Represents a controlled vocabulary term for well purposes.
+    """
+
+    thing_id: Mapped[int] = mapped_column(
+        Integer, ForeignKey("thing.id", ondelete="CASCADE"), nullable=False
+    )
+    purpose: Mapped[str] = lexicon_term(nullable=False, unique=True)
+
+    search_vector: Mapped[TSVectorType] = mapped_column(TSVectorType("purpose"))
+
+    thing: Mapped["Thing"] = relationship("Thing", back_populates="well_purposes")
+
+
+class WellCasingMaterial(Base, AutoBaseMixin, ReleaseMixin):
+    """
+    Represents a controlled vocabulary term for well casing materials.
+    """
+
+    thing_id: Mapped[int] = mapped_column(
+        Integer, ForeignKey("thing.id", ondelete="CASCADE"), nullable=False
+    )
+
+    material: Mapped[str] = lexicon_term(nullable=False, unique=True)
+
+    search_vector: Mapped[TSVectorType] = mapped_column(TSVectorType("material"))
+
+    thing: Mapped["Thing"] = relationship(
+        "Thing", back_populates="well_casing_materials"
+    )
+
+
 # TODO: this could be the model used to handle AMP monitoring
 # class FieldSamplingAdministation(Base, AutoBaseMixin):
 #     # the thing being monitored

schemas/thing.py

@@ -15,7 +15,7 @@
 # ===============================================================================
 from typing import List
 
-from pydantic import BaseModel, model_validator, PastDate, Field
+from pydantic import BaseModel, model_validator, PastDate, Field, field_validator
 
 from schemas import BaseCreateModel, BaseUpdateModel, BaseResponseModel
 from schemas.location import LocationResponse
@@ -89,7 +89,7 @@ class CreateWell(CreateBaseThing, ValidateWell):
     Schema for creating a well.
     """
 
-    well_purpose: str | None = None
+    well_purposes: list[str] | None = None
     well_depth: float | None = Field(
         default=None, gt=0, description="Well depth in feet"
     )
@@ -103,7 +103,7 @@ class CreateWell(CreateBaseThing, ValidateWell):
     well_casing_depth: float | None = Field(
         default=None, gt=0, description="Well casing depth in feet"
     )
-    well_casing_material: str | None = None
+    well_casing_materials: list[str] | None = None
 
 
 class CreateSpring(CreateBaseThing):
@@ -148,7 +148,7 @@ class WellResponse(BaseThingResponse):
     Response schema for well details.
     """
 
-    well_purpose: str | None = None  # e.g., "Production", "Observation", etc.
+    well_purposes: list[str] = []
     well_depth: float | None = None
     well_depth_unit: str = "ft"
     hole_depth: float | None = None
@@ -157,9 +157,28 @@ class WellResponse(BaseThingResponse):
     well_casing_diameter_unit: str = "in"
     well_casing_depth: float | None = None
     well_casing_depth_unit: str = "ft"
-    well_casing_material: str | None = None
+    well_casing_materials: list[str] = []
     well_construction_notes: str | None = None
 
+    @field_validator("well_purposes", mode="before")
+    def populate_well_purposes_with_strings(cls, well_purposes):
+        if len(well_purposes) > 0:
+            purposes = [well_purpose.purpose for well_purpose in well_purposes]
+        else:
+            purposes = []
+        return purposes
+
+    @field_validator("well_casing_materials", mode="before")
+    def populate_well_casing_materials_with_strings(cls, well_casing_materials):
+        if len(well_casing_materials) > 0:
+            materials = [
+                well_casing_material.material
+                for well_casing_material in well_casing_materials
+            ]
+        else:
+            materials = []
+        return materials
+
 
 class SpringResponse(BaseThingResponse):
     """
@@ -249,13 +268,13 @@ class UpdateThing(BaseUpdateModel):
 
 class UpdateWell(UpdateThing, ValidateWell):
 
-    well_purpose: str | None = None
+    well_purposes: list[str] | None = None
     well_depth: float | None = None  # in feet
     hole_depth: float | None = None  # in feet
     well_construction_notes: str | None = None
     well_casing_diameter: float | None = None  # in inches
     well_casing_depth: float | None = None  # in feet
-    well_casing_material: str | None = None
+    well_casing_materials: list[str] | None = None
 
 
 class UpdateSpring(UpdateThing):

services/thing_helper.py

@@ -20,7 +20,15 @@
 from sqlalchemy.orm import Session, aliased
 from starlette.status import HTTP_404_NOT_FOUND, HTTP_409_CONFLICT
 
-from db import LocationThingAssociation, Thing, Base, Location, WellScreen
+from db import (
+    LocationThingAssociation,
+    Thing,
+    Base,
+    Location,
+    WellScreen,
+    WellPurpose,
+    WellCasingMaterial,
+)
 from db.group import GroupThingAssociation
 from services.audit_helper import audit_add
 from services.crud_helper import model_patcher
@@ -136,6 +144,8 @@ def add_thing(
 
     location_id = data.pop("location_id", None)
     group_id = data.pop("group_id", None)
+    well_purposes = data.pop("well_purposes", None)
+    well_casing_materials = data.pop("well_casing_materials", None)
 
     try:
         thing = Thing(**data)
@@ -163,6 +173,22 @@ def add_thing(
             assoc.thing_id = thing.id
             session.add(assoc)
 
+        if well_purposes:
+            for well_purpose in well_purposes:
+                wp = WellPurpose()
+                audit_add(user, wp)
+                wp.thing_id = thing.id
+                wp.purpose = well_purpose
+                session.add(wp)
+
+        if well_casing_materials:
+            for well_casing_material in well_casing_materials:
+                wcm = WellCasingMaterial()
+                audit_add(user, wcm)
+                wcm.thing_id = thing.id
+                wcm.material = well_casing_material
+                session.add(wcm)
+
         session.commit()
         session.refresh(thing)
     except Exception as e:
@@ -213,6 +239,43 @@ def patch_thing(
 
     verify_thing_type_correspondence(thing, request)
 
+    data = payload.model_dump(exclude_unset=True)
+
+    if "water-well" in request.url.path:
+        well_purposes = data.pop("well_purposes", None)
+        well_casing_materials = data.pop("well_casing_materials", None)
+
+        if well_purposes is not None:
+            # delete existing purposes
+            session.query(WellPurpose).filter(WellPurpose.thing_id == thing.id).delete()
+            # add new purposes
+            for well_purpose in well_purposes:
+                wp = WellPurpose()
+                audit_add(user, wp)
+                wp.thing_id = thing.id
+                wp.purpose = well_purpose
+                session.add(wp)
+                session.commit()
+
+        if well_casing_materials is not None:
+            # delete existing materials
+            session.query(WellCasingMaterial).filter(
+                WellCasingMaterial.thing_id == thing.id
+            ).delete()
+            # add new materials
+            for well_casing_material in well_casing_materials:
+                wcm = WellCasingMaterial()
+                audit_add(user, wcm)
+                wcm.thing_id = thing.id
+                wcm.material = well_casing_material
+                session.add(wcm)
+                session.commit()
+
+    # remove these fields from payload after they have been handled
+    for field in ["well_purposes", "well_casing_materials"]:
+        if hasattr(payload, field):
+            delattr(payload, field)
+
     thing = model_patcher(session, Thing, thing_id, payload, user)
     return thing
 

tests/conftest.py

@@ -55,13 +55,11 @@ def water_well_thing(location):
             first_visit_date="2023-03-03",
             thing_type="water well",
             release_status="draft",
-            well_purpose="Domestic",
             well_depth=10,
             hole_depth=10,
             well_construction_notes="Test well construction notes",
             well_casing_diameter=5.0,
             well_casing_depth=10.0,
-            well_casing_material="PVC",
         )
         session.add(water_well)
         session.commit()
@@ -81,6 +79,66 @@ def water_well_thing(location):
         session.commit()
 
 
+@pytest.fixture()
+def pvc_well_casing_material(water_well_thing):
+    with session_ctx() as session:
+        casing_material = WellCasingMaterial(
+            thing_id=water_well_thing.id,
+            material="PVC",
+            release_status="draft",
+        )
+        session.add(casing_material)
+        session.commit()
+        yield casing_material
+        session.delete(casing_material)
+        session.commit()
+
+
+@pytest.fixture(scope="function")
+def steel_well_casing_material(water_well_thing):
+    with session_ctx() as session:
+        casing_material = WellCasingMaterial(
+            thing_id=water_well_thing.id,
+            material="Steel",
+            release_status="draft",
+        )
+        session.add(casing_material)
+        session.commit()
+        yield casing_material
+        session.delete(casing_material)
+        session.commit()
+
+
+@pytest.fixture()
+def irrigation_well_purpose(water_well_thing):
+    with session_ctx() as session:
+        purpose = WellPurpose(
+            thing_id=water_well_thing.id,
+            purpose="Irrigation",
+            release_status="draft",
+        )
+        session.add(purpose)
+        session.commit()
+        yield purpose
+        session.delete(purpose)
+        session.commit()
+
+
+@pytest.fixture()
+def domestic_well_purpose(water_well_thing):
+    with session_ctx() as session:
+        purpose = WellPurpose(
+            thing_id=water_well_thing.id,
+            purpose="Domestic",
+            release_status="draft",
+        )
+        session.add(purpose)
+        session.commit()
+        yield purpose
+        session.delete(purpose)
+        session.commit()
+
+
 @pytest.fixture()
 def well_screen(water_well_thing):
     with session_ctx() as session: