feat(CollectionComponents): add collection_components to model_components

Author: MaxNumerique

opengeodeweb_back_schemas.json

@@ -33,9 +33,9 @@
       }
     },
     "models": {
-      "mesh_components": {
-        "$id": "opengeodeweb_back/models/mesh_components",
-        "route": "/mesh_components",
+      "model_components": {
+        "$id": "opengeodeweb_back/models/model_components",
+        "route": "/model_components",
         "methods": [
           "POST"
         ],

src/opengeodeweb_back/geode_objects/geode_brep.py

@@ -76,6 +76,9 @@ def save_light_viewable(self, filename_without_extension: str) -> str:
     def mesh_components(self) -> ComponentRegistry:
         return self.brep.mesh_components()
 
+    def collection_components(self) -> ComponentRegistry:
+        return self.brep.collection_components()
+
     def inspect(self) -> og_inspector.BRepInspectionResult:
         return og_inspector.inspect_brep(self.brep)
 

src/opengeodeweb_back/geode_objects/geode_model.py

@@ -23,3 +23,6 @@ def viewer_elements_type(cls) -> ViewerElementsType:
 
     @abstractmethod
     def mesh_components(self) -> ComponentRegistry: ...
+
+    @abstractmethod
+    def collection_components(self) -> ComponentRegistry: ...

src/opengeodeweb_back/geode_objects/geode_section.py

@@ -78,6 +78,9 @@ def save_light_viewable(self, filename_without_extension: str) -> str:
     def mesh_components(self) -> ComponentRegistry:
         return self.section.mesh_components()
 
+    def collection_components(self) -> ComponentRegistry:
+        return self.section.collection_components()
+
     def inspect(self) -> og_inspector.SectionInspectionResult:
         return og_inspector.inspect_section(self.section)
 

src/opengeodeweb_back/routes/models/blueprint_models.py

@@ -12,14 +12,14 @@
 
 
 @routes.route(
-    schemas_dict["mesh_components"]["route"],
-    methods=schemas_dict["mesh_components"]["methods"],
+    schemas_dict["model_components"]["route"],
+    methods=schemas_dict["model_components"]["methods"],
 )
-def mesh_components() -> flask.Response:
+def model_components() -> flask.Response:
     json_data = utils_functions.validate_request(
-        flask.request, schemas_dict["mesh_components"]
+        flask.request, schemas_dict["model_components"]
     )
-    params = schemas.MeshComponents.from_dict(json_data)
+    params = schemas.ModelComponents.from_dict(json_data)
     model = geode_functions.load_geode_object(params.id)
     if not isinstance(model, GeodeModel):
         flask.abort(400, f"{params.id} is not a GeodeModel")
@@ -54,4 +54,24 @@ def mesh_components() -> flask.Response:
             }
             mesh_components.append(mesh_component_object)
 
-    return flask.make_response({"mesh_components": mesh_components}, 200)
+    model_collection_components = model.collection_components()
+    collection_components = []
+    for collection_component, ids in model_collection_components.items():
+        component_type = collection_component.get()
+        for id in ids:
+            geode_id = id.string()
+            collection_component_object = {
+                "id": params.id,
+                "geode_id": geode_id,
+                "name": geode_id,
+                "type": component_type,
+            }
+            collection_components.append(collection_component_object)
+
+    return flask.make_response(
+        {
+            "mesh_components": mesh_components,
+            "collection_components": collection_components,
+        },
+        200,
+    )

src/opengeodeweb_back/routes/models/schemas/__init__.py

@@ -1 +1 @@
-from .mesh_components import *
+from .model_components import *

…utes/models/schemas/mesh_components.json …tes/models/schemas/model_components.jsonsrc/opengeodeweb_back/routes/models/schemas/mesh_components.json renamed to src/opengeodeweb_back/routes/models/schemas/model_components.json src/opengeodeweb_back/routes/models/schemas/mesh_components.json renamed to src/opengeodeweb_back/routes/models/schemas/model_components.json

@@ -1,5 +1,5 @@
 {
-  "route": "/mesh_components",
+  "route": "/model_components",
   "methods": [
     "POST"
   ],

…routes/models/schemas/mesh_components.py …outes/models/schemas/model_components.pysrc/opengeodeweb_back/routes/models/schemas/mesh_components.py renamed to src/opengeodeweb_back/routes/models/schemas/model_components.py src/opengeodeweb_back/routes/models/schemas/mesh_components.py renamed to src/opengeodeweb_back/routes/models/schemas/model_components.py

@@ -3,7 +3,7 @@
 
 
 @dataclass
-class MeshComponents(DataClassJsonMixin):
+class ModelComponents(DataClassJsonMixin):
     def __post_init__(self) -> None:
         print(self, flush=True)
 

tests/test_models_routes.py

@@ -18,12 +18,12 @@
 data_dir = os.path.join(base_dir, "data")
 
 
-def test_mesh_components(client: FlaskClient) -> None:
+def test_model_components(client: FlaskClient) -> None:
     geode_object_type = "BRep"
     filename = "cube.og_brep"
     response = test_save_viewable_file(client, geode_object_type, filename)
 
-    route = "/opengeodeweb_back/models/mesh_components"
+    route = "/opengeodeweb_back/models/model_components"
     brep_filename = os.path.join(data_dir, "cube.og_brep")
 
     response = client.post(route, json={"id": response.get_json()["id"]})
@@ -39,6 +39,9 @@ def test_mesh_components(client: FlaskClient) -> None:
         assert isinstance(mesh_component["viewer_id"], int)
         assert isinstance(mesh_component["name"], str)
         assert isinstance(mesh_component["type"], str)
+    assert "collection_components" in response.get_json()
+    collection_components = response.get_json()["collection_components"]
+    assert isinstance(collection_components, list)
 
 
 def test_export_project_route(client: FlaskClient, tmp_path: Path) -> None: