feat: add methods to generate geometry_collection, geometry_collection2d and geometry_collection3d

Author: impocode

geojson_faker/__init__.py

@@ -1,11 +1,13 @@
 from geojson_faker.faker import GeoJsonFaker
 from geojson_faker.generators import (
     fake_altitude,
+    fake_geometry_collection,
     fake_latitude,
     fake_line_string,
     fake_longitude,
     fake_multi_line_string,
     fake_multi_point,
+    fake_multi_polygon,
     fake_point,
     fake_polygon,
     fake_position,
@@ -24,4 +26,6 @@
     "fake_line_string",
     "fake_multi_line_string",
     "fake_polygon",
+    "fake_multi_polygon",
+    "fake_geometry_collection",
 ]

geojson_faker/constants.py

@@ -25,6 +25,9 @@ class geo_keys(NamedTuple):
     multi_polygon = "multi_polygon"
     multi_polygon2d = "multi_polygon2d"
     multi_polygon3d = "multi_polygon3d"
+    geometry_collection = "geometry_collection"
+    geometry_collection2d = "geometry_collection2d"
+    geometry_collection3d = "geometry_collection3d"
 
 
 DIMENSIONS = [Dimension.two, Dimension.three]

geojson_faker/faker.py

@@ -2,6 +2,7 @@
 from typing import TypeVar
 
 from geojson_pydantic.geometries import (
+    GeometryCollection,
     LineString,
     MultiLineString,
     MultiPoint,
@@ -13,6 +14,7 @@
 
 from geojson_faker.constants import geo_keys
 from geojson_faker.generators import (
+    fake_geometry_collection,
     fake_line_string,
     fake_multi_line_string,
     fake_multi_point,
@@ -51,6 +53,9 @@ def __init__(self, random_always: bool = True):
             geo_keys.multi_polygon: None,
             geo_keys.multi_polygon2d: None,
             geo_keys.multi_polygon3d: None,
+            geo_keys.geometry_collection: None,
+            geo_keys.geometry_collection2d: None,
+            geo_keys.geometry_collection3d: None,
         }
 
     @property
@@ -159,6 +164,26 @@ def multi_polygon3d(self) -> MultiPolygon:
             func=fake_multi_polygon, geo_key=geo_keys.multi_polygon3d, dimension=Dimension.three
         )
 
+    @property
+    def geometry_collection(self) -> GeometryCollection:
+        return self._fake(func=fake_geometry_collection, geo_key=geo_keys.geometry_collection)
+
+    @property
+    def geometry_collection2d(self) -> GeometryCollection:
+        return self._fake(
+            func=fake_geometry_collection,
+            geo_key=geo_keys.geometry_collection2d,
+            dimension=Dimension.two,
+        )
+
+    @property
+    def geometry_collection3d(self) -> GeometryCollection:
+        return self._fake(
+            func=fake_geometry_collection,
+            geo_key=geo_keys.geometry_collection3d,
+            dimension=Dimension.three,
+        )
+
     def _fake(
         self,
         func: Callable[[Dimension | None], _GeoJsonType],

geojson_faker/generators.py

@@ -1,6 +1,7 @@
 from random import randint, randrange, uniform
 
 from geojson_pydantic.geometries import (
+    GeometryCollection,
     LineString,
     MultiLineString,
     MultiPoint,
@@ -140,3 +141,48 @@ def fake_multi_polygon(
             polygon_coordinates.append(linear_ring)
         coordinates.append(polygon_coordinates)
     return MultiPolygon(type="MultiPolygon", coordinates=coordinates)
+
+
+def fake_geometry_collection(
+    dimension: Dimension | None = None,
+    # points
+    max_points: int = 10,
+    # multi_points
+    max_multi_points: int = 10,
+    # line_strings
+    max_line_strings: int = 10,
+    # multi_line_strings
+    max_multi_line_strings: int = 10,
+    # polygons
+    max_polygons: int = 10,
+    # multi_polygons
+    max_multi_polygons: int = 10,
+) -> GeometryCollection:
+    geometries = []
+    if max_points > 0:
+        geometries.extend([fake_point(dimension=dimension) for _ in _randintrange(1, max_points)])
+    if max_multi_points > 0:
+        geometries.extend(
+            [fake_multi_point(dimension=dimension) for _ in _randintrange(1, max_multi_points)]
+        )
+    if max_line_strings > 0:
+        geometries.extend(
+            [fake_line_string(dimension=dimension) for _ in _randintrange(1, max_line_strings)]
+        )
+    if max_multi_line_strings > 0:
+        geometries.extend(
+            [
+                fake_multi_line_string(dimension=dimension)
+                for _ in _randintrange(1, max_multi_line_strings)
+            ]
+        )
+    if max_polygons > 0:
+        geometries.extend(
+            [fake_polygon(dimension=dimension) for _ in _randintrange(1, max_polygons)]
+        )
+    if max_multi_polygons > 0:
+        geometries.extend(
+            [fake_multi_polygon(dimension=dimension) for _ in _randintrange(1, max_multi_polygons)]
+        )
+
+    return GeometryCollection(type="GeometryCollection", geometries=geometries)

pyproject.toml

@@ -3,8 +3,8 @@ name = "geojson-faker"
 version = "0.3.0"
 description = "GeoJson fake generator."
 
-authors = ["impocode <impocode@impocode.com>"]
-maintainers = ["impocode <impocode@impocode.com>"]
+authors = ["impocode <impocode@impocode.one>"]
+maintainers = ["impocode <impocode@impocode.one>"]
 
 license= "MIT"
 readme = "readme.md"

tests/faker_test.py

@@ -1,10 +1,12 @@
 from geojson_pydantic.geometries import (
+    GeometryCollection,
     LineString,
     MultiLineString,
     MultiPoint,
     MultiPolygon,
     Point,
     Polygon,
+    _GeometryBase,
 )
 from geojson_pydantic.types import Position, Position2D, Position3D
 
@@ -362,3 +364,39 @@ def test_multi_polygon3d():
                 assert isinstance(coordinates.longitude, float)
                 assert isinstance(coordinates.latitude, float)
                 assert isinstance(coordinates.altitude, float)
+
+
+def test_geometry_collection():
+    geojson_faker = GeoJsonFaker()
+    geometry_collection = geojson_faker.geometry_collection
+
+    assert isinstance(geometry_collection, GeometryCollection)
+    assert geometry_collection.type == "GeometryCollection"
+    assert len(geometry_collection.geometries) > 0
+
+    for geometry in geometry_collection.geometries:
+        assert isinstance(geometry, _GeometryBase)
+
+
+def test_geometry_collection2d():
+    geojson_faker = GeoJsonFaker()
+    geometry_collection = geojson_faker.geometry_collection2d
+
+    assert isinstance(geometry_collection, GeometryCollection)
+    assert geometry_collection.type == "GeometryCollection"
+    assert len(geometry_collection.geometries) > 0
+
+    for geometry in geometry_collection.geometries:
+        assert isinstance(geometry, _GeometryBase)
+
+
+def test_geometry_collection3d():
+    geojson_faker = GeoJsonFaker()
+    geometry_collection = geojson_faker.geometry_collection3d
+
+    assert isinstance(geometry_collection, GeometryCollection)
+    assert geometry_collection.type == "GeometryCollection"
+    assert len(geometry_collection.geometries) > 0
+
+    for geometry in geometry_collection.geometries:
+        assert isinstance(geometry, _GeometryBase)