update: Make it easier to support new types (#26)

Author: mslaursen

fastapi_forge/data_type_registry.py

@@ -0,0 +1,125 @@
+from uuid import uuid4
+
+from pydantic import BaseModel
+
+from fastapi_forge.enums import FieldDataType
+
+
+class DataTypeInfo(BaseModel):
+    sqlalchemy_type: str
+    sqlalchemy_prefix: bool
+    python_type: str
+    faker_field_value: str
+    value: str
+    test_value: str
+    test_func: str = ""
+
+
+class DataTypeInfoRegistry:
+    def __init__(self):
+        self._registry: dict[FieldDataType, DataTypeInfo] = {}
+
+    def register(self, field_data_type: FieldDataType, data_type: DataTypeInfo):
+        if field_data_type in self._registry:
+            raise ValueError(f"Data type '{field_data_type}' is already registered.")
+        self._registry[field_data_type] = data_type
+
+    def get(self, field_data_type: FieldDataType) -> DataTypeInfo:
+        if field_data_type not in self._registry:
+            raise ValueError(f"Data type '{field_data_type}' not found.")
+        return self._registry[field_data_type]
+
+    def all(self) -> list[DataTypeInfo]:
+        return list(self._registry.values())
+
+
+registry = DataTypeInfoRegistry()
+faker_placeholder = "factory.Faker({placeholder})"
+
+
+registry.register(
+    FieldDataType.STRING,
+    DataTypeInfo(
+        sqlalchemy_type="String",
+        sqlalchemy_prefix=True,
+        python_type="str",
+        faker_field_value=faker_placeholder.format(placeholder='"text"'),
+        value="hello",
+        test_value="'world'",
+    ),
+)
+
+registry.register(
+    FieldDataType.INTEGER,
+    DataTypeInfo(
+        sqlalchemy_type="Integer",
+        sqlalchemy_prefix=True,
+        python_type="int",
+        faker_field_value=faker_placeholder.format(placeholder='"random_int"'),
+        value="1",
+        test_value="2",
+    ),
+)
+
+registry.register(
+    FieldDataType.FLOAT,
+    DataTypeInfo(
+        sqlalchemy_type="Float",
+        sqlalchemy_prefix=True,
+        python_type="float",
+        faker_field_value=faker_placeholder.format(
+            placeholder='"pyfloat", positive=True, min_value=0.1, max_value=100'
+        ),
+        value="1.0",
+        test_value="2.0",
+    ),
+)
+
+registry.register(
+    FieldDataType.BOOLEAN,
+    DataTypeInfo(
+        sqlalchemy_type="Boolean",
+        sqlalchemy_prefix=True,
+        python_type="bool",
+        faker_field_value=faker_placeholder.format(placeholder='"boolean"'),
+        value="True",
+        test_value="False",
+    ),
+)
+
+registry.register(
+    FieldDataType.DATETIME,
+    DataTypeInfo(
+        sqlalchemy_type="DateTime(timezone=True)",
+        sqlalchemy_prefix=True,
+        python_type="datetime",
+        faker_field_value=faker_placeholder.format(placeholder='"date_time"'),
+        value="datetime.now(timezone.utc)",
+        test_value="datetime.now(timezone.utc)",
+        test_func=".isoformat()",
+    ),
+)
+
+registry.register(
+    FieldDataType.UUID,
+    DataTypeInfo(
+        sqlalchemy_type="UUID(as_uuid=True)",
+        sqlalchemy_prefix=True,
+        python_type="UUID",
+        faker_field_value=str(uuid4()),
+        value=str(uuid4()),
+        test_value=str(uuid4()),
+    ),
+)
+
+registry.register(
+    FieldDataType.JSONB,
+    DataTypeInfo(
+        sqlalchemy_type="JSONB",
+        sqlalchemy_prefix=False,
+        python_type="dict[str, Any]",
+        faker_field_value="{}",
+        value="{}",
+        test_value='{"another_key": 123}',
+    ),
+)

fastapi_forge/dtos.py

@@ -9,6 +9,7 @@
     model_validator,
 )
 
+from fastapi_forge.data_type_registry import DataTypeInfo, registry
 from fastapi_forge.enums import FieldDataType
 from fastapi_forge.string_utils import camel_to_snake_hyphen, snake_to_camel
 
@@ -44,10 +45,8 @@ class ModelField(_Base):
     nullable: bool = False
     unique: bool = False
     index: bool = False
-
     default_value: str | None = None
     extra_kwargs: dict[str, Any] | None = None
-
     metadata: ModelFieldMetadata = ModelFieldMetadata()
 
     @computed_field
@@ -56,6 +55,11 @@ def name_cc(self) -> str:
         """Convert field name to camelCase."""
         return snake_to_camel(self.name)
 
+    @computed_field
+    @property
+    def type_info(self) -> DataTypeInfo:
+        return registry.get(self.type)
+
     @model_validator(mode="after")
     def _validate(self) -> Self:
         """Validate field constraints."""
@@ -88,32 +92,6 @@ def _validate(self) -> Self:
             )
         return self
 
-    @computed_field
-    @property
-    def factory_field_value(self) -> str | dict | None:
-        """Return the appropriate factory default for the model field."""
-        faker_placeholder = "factory.Faker({placeholder})"
-
-        if "email" in self.name and self.type == FieldDataType.STRING:
-            return faker_placeholder.format(placeholder='"email"')
-
-        type_to_faker = {
-            FieldDataType.STRING: '"text"',
-            FieldDataType.INTEGER: '"random_int"',
-            FieldDataType.FLOAT: '"pyfloat", positive=True, min_value=0.1, max_value=100',
-            FieldDataType.BOOLEAN: '"boolean"',
-            FieldDataType.DATETIME: '"date_time"',
-            FieldDataType.JSONB: {},
-        }
-
-        if self.type not in type_to_faker:
-            return None
-
-        if self.type == FieldDataType.JSONB:
-            return type_to_faker[FieldDataType.JSONB]
-
-        return faker_placeholder.format(placeholder=type_to_faker[self.type])
-
 
 class ModelRelationship(_Base):
     """Represents a relationship between models."""

fastapi_forge/enums.py

@@ -1,6 +1,14 @@
 from enum import StrEnum
 
 
+class HTTPMethod(StrEnum):
+    GET = "get"
+    GET_ID = "get_id"
+    POST = "post"
+    PATCH = "patch"
+    DELETE = "delete"
+
+
 class FieldDataType(StrEnum):
     STRING = "String"
     INTEGER = "Integer"
@@ -9,22 +17,3 @@ class FieldDataType(StrEnum):
     DATETIME = "DateTime"
     UUID = "UUID"
     JSONB = "JSONB"
-
-    def as_python_type(self) -> str:
-        return {
-            FieldDataType.STRING: "str",
-            FieldDataType.INTEGER: "int",
-            FieldDataType.FLOAT: "float",
-            FieldDataType.BOOLEAN: "bool",
-            FieldDataType.DATETIME: "datetime",
-            FieldDataType.UUID: "UUID",
-            FieldDataType.JSONB: "dict[str, Any]",
-        }[self]
-
-
-class HTTPMethod(StrEnum):
-    GET = "get"
-    GET_ID = "get_id"
-    POST = "post"
-    PATCH = "patch"
-    DELETE = "delete"