scaffold-ca-python 0.2.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

scaffold_ca_python/commands/generate_model.py

@@ -16,12 +16,12 @@ from scaffold_ca_python.commands._shared import (
 )
 from scaffold_ca_python.core.module_builder import ModuleBuilder
 from scaffold_ca_python.core.name_utils import validate_module_name
-from scaffold_ca_python.core.project_detector import load_project_context
+from scaffold_ca_python.core.project_detector import load_project_context, resolve_tests_root
 from scaffold_ca_python.factory.simple.model_factory import ModelFactory
 from scaffold_ca_python.models.context import ModuleContext
 from scaffold_ca_python.models.layer import Layer
 
-_GM_HELP = "Scaffold a Pydantic v2 domain model and test stub. Alias 'gm'."
+_GM_HELP = "Scaffold a Pydantic v2 domain model, its gateway, and test stubs. Alias 'gm'."
 _GM_EPILOG = "Example:\n\n  * scaffold gm --name order\n\n  * scaffold generate-model --name order\n\n"
 
 
@@ -31,12 +31,24 @@ def _generate_model_impl(name: str, dry_run: bool) -> None:
     project_ctx = load_project_context(project_root)
     module_ctx = ModuleContext(name=name, layer=Layer.DOMAIN_MODEL, project=project_ctx)
 
-    src_path = project_root / "src" / project_ctx.python_package / "domain" / "model" / f"{module_ctx.module_name}.py"
+    model_root = project_root / "src" / project_ctx.python_package / "domain" / "model"
     ensure_absent(
-        src_path,
+        model_root / module_ctx.module_name,
+        project_root,
+        kind="Directory",
+        hint="Choose a different name or remove the existing folder first.",
+    )
+    ensure_absent(
+        model_root / f"{module_ctx.module_name}.py",
         project_root,
         kind="File",
-        hint="Choose a different name or remove the existing file first.",
+        hint="A model with this name already exists in the legacy flat layout. Remove it or choose a different name.",
+    )
+    ensure_absent(
+        resolve_tests_root(project_root) / "domain" / "model" / module_ctx.module_name,
+        project_root,
+        kind="Directory",
+        hint="Remove the leftover tests folder or choose a different name.",
     )
 
     builder = ModuleBuilder(project_root=project_root, project_ctx=project_ctx, module_ctx=module_ctx, dry_run=dry_run)
@@ -70,7 +82,7 @@ def register(app: typer.Typer) -> None:
             ),
         ] = False,
     ) -> None:
-        """Scaffold a domain model in domain/model/."""
+        """Scaffold a domain model package with its gateway in domain/model/<name>/."""
         if name is None:
             typer.echo(ctx.get_help())
             raise typer.Exit(0)

scaffold_ca_python/core/module_locator.py

@@ -10,7 +10,8 @@ from scaffold_ca_python.core.project_detector import resolve_tests_root
 def find_module_targets(project_root: Path, pkg: str, snake: str) -> list[tuple[Path, Path | None]]:
     """Return ``(src_path, test_path | None)`` pairs for every match of *snake*.
 
-    Searches in order: domain/model, domain/usecase, driven_adapters,
+    Searches in order: domain/model/<snake>/ (package), domain/model/<snake>.py (legacy flat),
+    domain/usecase, driven_adapters,
     entry_points, helpers.
     """
     src_root = project_root / "src" / pkg
@@ -18,6 +19,11 @@ def find_module_targets(project_root: Path, pkg: str, snake: str) -> list[tuple[
 
     candidates: list[tuple[Path, Path | None]] = []
 
+    model_pkg = src_root / "domain" / "model" / snake
+    if model_pkg.is_dir():
+        model_pkg_test = tests_root / "domain" / "model" / snake
+        candidates.append((model_pkg, model_pkg_test if model_pkg_test.exists() else None))
+
     for src_rel, test_rel in [
         (src_root / "domain" / "model" / f"{snake}.py", tests_root / "domain" / "model" / f"test_{snake}.py"),
         (src_root / "domain" / "usecase" / f"{snake}.py", tests_root / "domain" / "usecase" / f"test_{snake}.py"),

scaffold_ca_python/factory/simple/delete_module_factory.py

@@ -6,8 +6,8 @@ import shutil
 from pathlib import Path
 from typing import TYPE_CHECKING
 
+from scaffold_ca_python.core.module_locator import find_module_targets
 from scaffold_ca_python.core.name_utils import to_snake_case
-from scaffold_ca_python.core.project_detector import resolve_tests_root
 from scaffold_ca_python.factory import ModuleFactory
 
 if TYPE_CHECKING:
@@ -21,7 +21,7 @@ class DeleteModuleFactory(ModuleFactory):
         """Build deletion operations for a module.
 
         Finds and deletes modules across:
-        - domain/model/<snake>.py
+        - domain/model/<snake>/ (package) or domain/model/<snake>.py (legacy)
         - domain/usecase/<snake>.py
         - infrastructure/driven_adapters/<snake>/
         - infrastructure/entry_points/<snake>/
@@ -34,41 +34,7 @@ class DeleteModuleFactory(ModuleFactory):
         module_name = builder.module_ctx.name if builder.module_ctx else "Module"
         snake_name = to_snake_case(module_name)
 
-        src_root = project_root / "src" / pkg
-        tests_root = resolve_tests_root(project_root)
-
-        # Build list of possible module locations
-        candidates: list[tuple[Path, Path | None]] = []
-
-        # Single-file layers (domain/model, domain/usecase)
-        model_src = src_root / "domain" / "model" / f"{snake_name}.py"
-        model_test = tests_root / "domain" / "model" / f"test_{snake_name}.py"
-        usecase_src = src_root / "domain" / "usecase" / f"{snake_name}.py"
-        usecase_test = tests_root / "domain" / "usecase" / f"test_{snake_name}.py"
-        for src_rel, test_rel in [
-            (model_src, model_test),
-            (usecase_src, usecase_test),
-        ]:
-            if src_rel.exists():
-                candidates.append((src_rel, test_rel if test_rel.exists() else None))
-
-        # Directory-based layers (infrastructure sub-dirs)
-        for src_rel, test_rel in [
-            (
-                src_root / "infrastructure" / "driven_adapters" / snake_name,
-                tests_root / "infrastructure" / "driven_adapters" / snake_name,
-            ),
-            (
-                src_root / "infrastructure" / "entry_points" / snake_name,
-                tests_root / "infrastructure" / "entry_points" / snake_name,
-            ),
-            (
-                src_root / "infrastructure" / "helpers" / snake_name,
-                tests_root / "infrastructure" / "helpers" / snake_name,
-            ),
-        ]:
-            if src_rel.exists():
-                candidates.append((src_rel, test_rel if test_rel.exists() else None))
+        candidates = find_module_targets(project_root, pkg, snake_name)
 
         if not builder.dry_run:
             for src_path, test_path in candidates:

scaffold_ca_python/factory/simple/model_factory.py

@@ -15,43 +15,48 @@ class ModelFactory(ModuleFactory):
     """Factory for domain model generation."""
 
     def build(self, builder: ModuleBuilder) -> None:
-        """Build domain model files.
+        """Build domain model package files.
 
         Queues files:
-        - src/domain/model/{module_name}.py
-        - tests/domain/model/test_{module_name}.py
+        - src/domain/model/{module_name}/__init__.py
+        - src/domain/model/{module_name}/{module_name}.py
+        - src/domain/model/{module_name}/gateways/__init__.py
+        - src/domain/model/{module_name}/gateways/{module_name}_repository.py
+        - tests/domain/model/{module_name}/test_{module_name}.py
+        - tests/domain/model/{module_name}/gateways/test_{module_name}_repository.py
 
         No dependencies injected (pydantic is already a project dependency).
         """
         project_root = builder.project_root
         pkg = builder.project_ctx.python_package
 
-        # Get module name from module context
         module_name = builder.module_ctx.module_name if builder.module_ctx else "model"
 
-        # Setup directory paths
-        src_dir = project_root / "src" / pkg / "domain" / "model"
-        test_dir = resolve_tests_root(project_root) / "domain" / "model"
+        src_dir = project_root / "src" / pkg / "domain" / "model" / module_name
+        gateways_dir = src_dir / "gateways"
+        test_dir = resolve_tests_root(project_root) / "domain" / "model" / module_name
+        test_gateways_dir = test_dir / "gateways"
 
-        # Template base path
         base = "model"
 
-        # Build context dict from module context
         ctx_dict = {}
         if builder.module_ctx:
             ctx_dict.update(builder.module_ctx.model_dump())
 
-        # Add source file
-        builder.add_file(
-            src_dir / f"{module_name}.py",
-            builder.render(f"{base}/model.py.jinja2", ctx_dict),
-            template_name=f"{base}/model.py.jinja2",
-        )
-
-        # Add test file
-        builder.add_file(
-            test_dir / f"test_{module_name}.py",
-            builder.render(f"{base}/test_model.py.jinja2", ctx_dict),
-            template_name=f"{base}/test_model.py.jinja2",
-            is_test=True,
-        )
+        # (target path, template file name, is_test)
+        files = [
+            (src_dir / "__init__.py", "__init__.py.jinja2", False),
+            (src_dir / f"{module_name}.py", "model.py.jinja2", False),
+            (gateways_dir / "__init__.py", "gateways_init.py.jinja2", False),
+            (gateways_dir / f"{module_name}_repository.py", "gateway.py.jinja2", False),
+            (test_dir / f"test_{module_name}.py", "test_model.py.jinja2", True),
+            (test_gateways_dir / f"test_{module_name}_repository.py", "test_gateway.py.jinja2", True),
+        ]
+        for path, template, is_test in files:
+            template_name = f"{base}/{template}"
+            builder.add_file(
+                path,
+                builder.render(template_name, ctx_dict),
+                template_name=template_name,
+                is_test=is_test,
+            )

scaffold_ca_python/templates/model/__init__.py.jinja2

@@ -0,0 +1 @@
+"""{{ class_name }} domain model package."""

scaffold_ca_python/templates/model/gateway.py.jinja2

@@ -0,0 +1,7 @@
+"""{{ class_name }} gateway."""
+
+from abc import ABC
+
+
+class {{ class_name }}Repository(ABC):
+    """Repository contract for {{ class_name }}. Add the operations your domain needs."""

scaffold_ca_python/templates/model/gateways_init.py.jinja2

@@ -0,0 +1 @@
+"""{{ class_name }} gateways."""

scaffold_ca_python/templates/model/test_gateway.py.jinja2

@@ -0,0 +1,9 @@
+"""Tests for {{ class_name }}Repository gateway."""
+
+from abc import ABC
+
+from {{ project.python_package }}.domain.model.{{ module_name }}.gateways.{{ module_name }}_repository import {{ class_name }}Repository
+
+
+def test_{{ module_name }}_repository_is_abstract_contract() -> None:
+    assert issubclass({{ class_name }}Repository, ABC)

scaffold_ca_python/templates/model/test_model.py.jinja2

@@ -1,6 +1,6 @@
 """Tests for {{ class_name }} domain model."""
 
-from {{ project.python_package }}.domain.model.{{ module_name }} import {{ class_name }}
+from {{ project.python_package }}.domain.model.{{ module_name }}.{{ module_name }} import {{ class_name }}
 
 
 def test_{{ module_name }}_can_be_instantiated() -> None:

{scaffold_ca_python-0.2.1.dist-info → scaffold_ca_python-0.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: scaffold-ca-python
-Version: 0.2.1
+Version: 0.3.0
 Summary: Scaffolder to generate Clean Architecture apps
 Project-URL: Homepage, https://github.com/bancolombia/scaffold-clean-architecture-py
 Project-URL: Repository, https://github.com/bancolombia/scaffold-clean-architecture-py
@@ -105,12 +105,23 @@ scaffold ca --name my-project --dry-run
 
 ### scaffold gm
 
-Scaffold a Pydantic v2 domain model and its test stub.
+Scaffold a Pydantic v2 domain model, its gateway (an empty abstract repository contract), and test stubs.
 
 ```bash
 scaffold gm --name order
 ```
 
+Generated structure:
+
+```text
+domain/model/order/
+├── __init__.py
+├── order.py
+└── gateways/
+    ├── __init__.py
+    └── order_repository.py
+```
+
 ```bash
 scaffold gm --name order --dry-run
 ```

{scaffold_ca_python-0.2.1.dist-info → scaffold_ca_python-0.3.0.dist-info}/RECORD

@@ -8,7 +8,7 @@ scaffold_ca_python/commands/delete_module.py,sha256=J-nkA_o9mY2AOOzQBg3kyTEWm6el
 scaffold_ca_python/commands/generate_driven_adapter.py,sha256=IRGXCinpa694_9W7WXL7k43hOm9V52Jk87DVgayzeEs,4215
 scaffold_ca_python/commands/generate_entry_point.py,sha256=NvHF1auzB0bfcx9KzaHCx3Z_pA0FLswwDB9yW3LdKG8,9449
 scaffold_ca_python/commands/generate_helper.py,sha256=O98ua5Fj3judGxF_vmTYbm_j-qEAxGd4eA0F1YYtPqM,2884
-scaffold_ca_python/commands/generate_model.py,sha256=1oKXtRz7JkPPNZkmE-Kw1sOBUQgWnKo6IXYHxPf4-60,2839
+scaffold_ca_python/commands/generate_model.py,sha256=GBHPkoTYrABNdmdILWGLuQFM4ppzYbuHyunjhc-o4Dc,3387
 scaffold_ca_python/commands/generate_pipeline.py,sha256=Ip-rN4nSbwaUbtJ49awAs4LDURsrDTQsZdG5kBCLdyE,3773
 scaffold_ca_python/commands/generate_project.py,sha256=5KRsPI_WiWQVY1d_0AblUHKdDQCWpXJA7MaOCHae0fE,5312
 scaffold_ca_python/commands/generate_use_case.py,sha256=N72h2BAyNgbCLiphryrwF1aDXkDL5NNj14Lsq7D3YFE,2947
@@ -18,7 +18,7 @@ scaffold_ca_python/core/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG
 scaffold_ca_python/core/file_writer.py,sha256=KdnNrq33Jsvqs1IQf0jbUKdXls4jBSWAizw4uJhMalU,5561
 scaffold_ca_python/core/mcp_tool_spec.py,sha256=mPLN7vOSgWFWxHQQxmr0fWEaimHWI-9A0oP7ob73-rU,10602
 scaffold_ca_python/core/module_builder.py,sha256=AHC3szEdfS3i3q74IM6USZTHWEUK6QizL6NEKcHCrrI,6837
-scaffold_ca_python/core/module_locator.py,sha256=VEZapvZqk11-5brsHJvPdIsKlEWSTdwS6T9XF9o0acE,1657
+scaffold_ca_python/core/module_locator.py,sha256=VnvD3-g6NvSGJReYamBuoU1s72NdoHgau-SlpaB3xEg,1958
 scaffold_ca_python/core/name_utils.py,sha256=195Qb36CafP4CGRomzSAm3Hmm0C-Qld3I90boPAV-7A,2583
 scaffold_ca_python/core/openapi_routes.py,sha256=RCQS7mHufWJZgbLI1cxGli-xGbU7p7WI95fHJhDnIss,1098
 scaffold_ca_python/core/project_detector.py,sha256=vcDAFCGgQVDMQ2MivJVUmn5Yyj58vGpTbzKhZTBQNtw,3524
@@ -40,9 +40,9 @@ scaffold_ca_python/factory/entry_points/ep_restapi.py,sha256=PFkt9TH1aN6YO8w4zAe
 scaffold_ca_python/factory/pipelines/__init__.py,sha256=0YPpPGsZ6A3-udHTSZDyUHleLFLQQh1V5IL6AB0qJ6g,557
 scaffold_ca_python/factory/pipelines/pipeline_factory.py,sha256=s4fpuyhdxXiwko-LlM6Pv-QJdRGQJb17KVrC-DW6ojo,842
 scaffold_ca_python/factory/simple/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-scaffold_ca_python/factory/simple/delete_module_factory.py,sha256=lw4_XCJegvDqxlZ7o6kDJ792rugOiUijCH1tVsiwRJI,3119
+scaffold_ca_python/factory/simple/delete_module_factory.py,sha256=hvDZNz8TULYx0zES3697-jnrzDQT6v6nxqPV0H9-mWo,1651
 scaffold_ca_python/factory/simple/helper_factory.py,sha256=nBVOu_kGBVrEGnXFa918GPo-UFlcW-Y5-Uk6bwYWuhQ,2295
-scaffold_ca_python/factory/simple/model_factory.py,sha256=cgI3TRCUNfNUBQY5mO-9mhNOwW5LWEVk6Y9rsx120Tg,1807
+scaffold_ca_python/factory/simple/model_factory.py,sha256=YdUpBvGgUrz4zzXMG2p8d6PWit62B9esjLZG49dT5PU,2467
 scaffold_ca_python/factory/simple/use_case_factory.py,sha256=znCyynIGmWgc4P8icJXfb2xSiNZB2Cu4SGVacDrpSdY,1954
 scaffold_ca_python/models/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 scaffold_ca_python/models/context.py,sha256=Itp-YyPgY-0yNYA9YlCXrmPfa5nEVklGAOJQGHfBdHE,1909
@@ -94,8 +94,12 @@ scaffold_ca_python/templates/entry_point/restapi/test_server.py.jinja2,sha256=7_
 scaffold_ca_python/templates/helper/__init__.py.jinja2,sha256=LA4hikmh30a_8LgZ8h18zdC3NEfDPNJeZOSBJ4RZBwU,39
 scaffold_ca_python/templates/helper/helper.py.jinja2,sha256=rPaSM5Y4U25Ht8nshnw9m_fc3FXkx-CHA_egJM7QDmc,110
 scaffold_ca_python/templates/helper/test_helper.py.jinja2,sha256=5nmkjej1FQngXh5JAoftdRvE8kdad0Knjxf25Lb--RI,268
+scaffold_ca_python/templates/model/__init__.py.jinja2,sha256=fz54Iv6Z8sDtCMgIz8eFBXokdDz0SA2uhQMf8IGYUcs,45
+scaffold_ca_python/templates/model/gateway.py.jinja2,sha256=o2FNIfFseauf_5REavVnM-Qe7k8rjoXRqSuqtOI0vIk,184
+scaffold_ca_python/templates/model/gateways_init.py.jinja2,sha256=8bO2y7wFlMVRMURwxLD9ubAHuu71YXCRhGtfSjkWtcM,33
 scaffold_ca_python/templates/model/model.py.jinja2,sha256=pvzy78xH5-qWJ6IQb-9bY-dnqPj4FPBsQ-Kalh_mFr0,151
-scaffold_ca_python/templates/model/test_model.py.jinja2,sha256=55F0CUHb2A3D5ikSNgPveNZ1Jt11gwfzKqGKHYjuzLo,263
+scaffold_ca_python/templates/model/test_gateway.py.jinja2,sha256=xedkiihpUCARhGSKEPLmAlbJ0yOxS2uvDwpIdLbmSFg,338
+scaffold_ca_python/templates/model/test_model.py.jinja2,sha256=Wdz84c8Yt6aeUFQIINdfsq0K9Ihk7GT_ZVzpEGrQ4uM,281
 scaffold_ca_python/templates/pipeline/azure/azure_pipelines.yml.jinja2,sha256=ecbvubtMhoyqxiM69PunOYwOOBBLUFqSBsoqJsIqyDI,555
 scaffold_ca_python/templates/pipeline/github/ci.yml.jinja2,sha256=y20dpIoOHlZNCIXzyJdjsTgq2HiyCjHpcg2UPKZuQRg,672
 scaffold_ca_python/templates/project/README.jinja2,sha256=HazR7Ls3utOfMFjxDsVS1-WMCPG1OR4XR2ftn02Fnuo,696
@@ -117,8 +121,8 @@ scaffold_ca_python/templates/project/application/config/resource_container.py.ji
 scaffold_ca_python/templates/project/application/config/usecases_container.py.jinja2,sha256=3fEHe6mkXkDHlfO5nhLqzLB7ccTpqwtjHZfLyfysbro,527
 scaffold_ca_python/templates/use_case/test_use_case.py.jinja2,sha256=3K1bNKDBQc29rcv8UHUZnROCUmcFSCwJhbm0xP9Uako,364
 scaffold_ca_python/templates/use_case/use_case.py.jinja2,sha256=KPtaK1wvZ-7qHdDZyuVfqXTPYwJdNUMPXQZGuKZFA7Y,217
-scaffold_ca_python-0.2.1.dist-info/METADATA,sha256=VxmJhT8bnSFEI4UGZznCyJSHD5QqDaVDrdWtxstKtYc,6960
-scaffold_ca_python-0.2.1.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
-scaffold_ca_python-0.2.1.dist-info/entry_points.txt,sha256=4PyYg6mNCvAlt2yF_o1-QR2CBXiowYGpNyqcP88tu6I,104
-scaffold_ca_python-0.2.1.dist-info/licenses/LICENSE,sha256=3ZZEP7DK_h3lEjS8r-DvQCec2q7zAqqq7HmSq6cuL0E,1068
-scaffold_ca_python-0.2.1.dist-info/RECORD,,
+scaffold_ca_python-0.3.0.dist-info/METADATA,sha256=u5KDkAfy1Wb0HVt1Jrb2MzZr2Nqgb9xnwOZhhmmwVKw,7187
+scaffold_ca_python-0.3.0.dist-info/WHEEL,sha256=W3fkpkm7-wf9vBI5Z-7s0eWkeM-spu78I8Neb98DeEg,87
+scaffold_ca_python-0.3.0.dist-info/entry_points.txt,sha256=4PyYg6mNCvAlt2yF_o1-QR2CBXiowYGpNyqcP88tu6I,104
+scaffold_ca_python-0.3.0.dist-info/licenses/LICENSE,sha256=3ZZEP7DK_h3lEjS8r-DvQCec2q7zAqqq7HmSq6cuL0E,1068
+scaffold_ca_python-0.3.0.dist-info/RECORD,,