fix: Rename the "MergeProject" recipe to "MergeProjects" (#5187)

* fix: Rename the "MergeProject" recipe to "MergeProjects"

This rename, alongside renaming "filepath" to "filepaths" and adjusting the docstring has been done to clarify, that this patch can be used to merge multiple IFC files into one (and not just two)

* fix: Fix `test_Merge_Project.py`, which was broken due to renaming the patch recipe

src/ifcpatch/ifcpatch/recipes/MergeProjects.py

@@ -27,35 +27,35 @@ from logging import Logger
 
 
 class Patcher:
-    def __init__(self, src: str, file: ifcopenshell.file, logger: Logger, filepath: Union[str, ifcopenshell.file]):
-        """Merge two IFC models into one
+    def __init__(self, src: str, file: ifcopenshell.file, logger: Logger, filepaths: Union[str, ifcopenshell.file]):
+        """Merge two or more IFC models into one
 
-        Note that other than combining the two IfcProject elements into one, no
-        further processing will be done. This means that you may end up with
-        duplicate spatial hierarchies (i.e. 2 sites, 2 buildings, etc).
+        Note that other than combining the two (or more) IfcProject elements into
+        one, no further processing will be done. This means that you may end up
+        with duplicate spatial hierarchies (i.e. 2 sites, 2 buildings, etc).
 
         Will automatically convert length units in the second model to the main
         model's unit before merging.
 
-        :param filepath: The filepath of the second IFC model to merge into the
-            first. The first model is already specified as the input to
-            IfcPatch.
-        :type filepath: Union[str, ifcopenshell.file]
-        :filter_glob filepath: *.ifc;*.ifczip;*.ifcxml
+        :param filepaths: The filepath(s) of the second (, third, ...) IFC model
+            to merge into the first. The first model is already specified as the
+            input to IfcPatch.
+        :type filepaths: Union[str, ifcopenshell.file]
+        :filter_glob filepaths: *.ifc;*.ifczip;*.ifcxml
 
         Example:
 
         .. code:: python
 
-            ifcpatch.execute({"input": "input.ifc", "file": model, "recipe": "MergeProject", "arguments": ["/path/to/model2.ifc"]})
+            ifcpatch.execute({"input": "input.ifc", "file": model, "recipe": "MergeProjects", "arguments": ["/path/to/model2.ifc"]})
         """
         self.src = src
         self.file = file
         self.logger = logger
-        self.filepath = filepath
+        self.filepaths = filepaths
 
     def patch(self):
-        for filepath in self.filepath:
+        for filepath in self.filepaths:
             if isinstance(filepath, ifcopenshell.file):
                 other = filepath
             else:

src/ifcpatch/test/test_MergeProject.py

@@ -34,7 +34,7 @@ from pathlib import Path
 from typing import Optional
 
 
-class TestMergeProject(test.bootstrap.IFC4):
+class TestMergeProjects(test.bootstrap.IFC4):
     def setup_project(self, ifc_file: Optional[ifcopenshell.file] = None):
         prefix = None if ifc_file else "MILLI"
         if ifc_file is None:
@@ -57,7 +57,7 @@ class TestMergeProject(test.bootstrap.IFC4):
         second_file = self.setup_project()
         temp_path = Path(tempfile.gettempdir()) / "second.ifc"
         second_file.write(temp_path)
-        output = ifcpatch.execute({"file": self.file, "recipe": "MergeProject", "arguments": [str(temp_path)]})
+        output = ifcpatch.execute({"file": self.file, "recipe": "MergeProjects", "arguments": [str(temp_path)]})
 
         assert self.file == output
         assert len(output.by_type("IfcWall")) == 2
@@ -74,7 +74,7 @@ class TestMergeProject(test.bootstrap.IFC4):
     def test_reusing_geometric_contexts(self):
         self.file = self.setup_project(self.file)
         second_file = self.setup_project()
-        output = ifcpatch.execute({"file": self.file, "recipe": "MergeProject", "arguments": [second_file]})
+        output = ifcpatch.execute({"file": self.file, "recipe": "MergeProjects", "arguments": [second_file]})
         assert len(output.by_type("IfcGeometricRepresentationContext")) == 2
 
     def test_using_the_georeferencing_of_the_original_project(self):
@@ -84,7 +84,7 @@ class TestMergeProject(test.bootstrap.IFC4):
         second_file = self.setup_project()
         ifcopenshell.api.georeference.add_georeferencing(self.file)
         ifcopenshell.api.georeference.add_georeferencing(second_file)
-        output = ifcpatch.execute({"file": self.file, "recipe": "MergeProject", "arguments": [second_file]})
+        output = ifcpatch.execute({"file": self.file, "recipe": "MergeProjects", "arguments": [second_file]})
         assert len(output.by_type("IfcProjectedCRS")) == 1
         assert len(output.by_type("IfcMapConversion")) == 1
 
@@ -143,7 +143,7 @@ class TestMergeProject(test.bootstrap.IFC4):
         assert np.any(np.all(np.isclose(np.array((1.0, 2.0, 3.0)), verts), axis=1))
         assert np.any(np.all(np.isclose(np.array((3.0, 4.0, 5.0)), verts), axis=1))
 
-        output = ifcpatch.execute({"file": self.file, "recipe": "MergeProject", "arguments": [second_file]})
+        output = ifcpatch.execute({"file": self.file, "recipe": "MergeProjects", "arguments": [second_file]})
 
         # In the future we may use proj to support reprojection from different CRSes. For now... nope!
         if self.file.schema != "IFC2X3":
@@ -174,5 +174,5 @@ class TestMergeProject(test.bootstrap.IFC4):
         assert np.any(np.all(np.isclose(np.array((20.410, 25.902, 5.0)), verts, atol=1e-3), axis=1))
 
 
-class TestMergeProjectIFC2X3(test.bootstrap.IFC2X3, TestMergeProject):
+class TestMergeProjectsIFC2X3(test.bootstrap.IFC2X3, TestMergeProjects):
     pass