modwire 3.1.1__tar.gz → 3.2.0__tar.gz

{modwire-3.1.1 → modwire-3.2.0}/CHANGELOG.md

@@ -1,6 +1,24 @@
 # Changelog
 
-## 3.0.0 - Unreleased
+## 3.2.0 - Unreleased
+
+### Added
+
+- Project generation through `modwire.projects.generate_project`.
+- Bundled project profiles for Python/FastAPI/uv, TypeScript/NestJS/pnpm, and
+  PHP/Symfony/Composer.
+- Project authority loading and project-aware context/module operations through
+  `modwire.projects.open_project`.
+- Bundled `clean` and `ddd_context` module scaffoldings alongside the existing
+  `layered` and `hexagonal` scaffoldings.
+- Python, TypeScript, and PHP outputs for bundled DDD context module generation.
+
+### Changed
+
+- README project-generation documentation now covers project-aware operations and
+  the currently bundled project profiles.
+
+## 3.0.0
 
 ### Breaking Changes
 

{modwire-3.1.1 → modwire-3.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: modwire
-Version: 3.1.1
+Version: 3.2.0
 Summary: Map architecture boundaries and analyze extracted code maps.
 Author: Tomasz Szpak
 License-Expression: MIT
@@ -134,7 +134,56 @@ generate_module(
 ```
 
 If no template path is provided, `generate_module` uses the bundled `layered`
-scaffolding. Bundled scaffoldings are packaged with the distribution wheel.
+scaffolding. Pass `scaffolding="hexagonal"` for a pluggable domain/ports/adapters
+structure, `scaffolding="clean"` for a domain/application/infrastructure/interface
+module, or `scaffolding="ddd_context"` for a bounded-context module. Bundled
+scaffoldings are packaged with the distribution wheel.
+
+## Project Generation
+
+`modwire.projects` can generate a project authority and starter layout. The
+default bundled project profile is `python-fastapi-ddd-uv`: Python, uv,
+FastAPI, and a DDD-oriented package layout that mounts reusable `ddd_context`
+module scaffolding under the application package.
+
+```python
+from pathlib import Path
+
+from modwire.projects import generate_project
+
+generate_project("acme", Path("services/acme"))
+```
+
+The generated project includes `.modwire/project.json`, which records the
+resolved profile, layout, dependencies, module scaffolding, and operation names
+for later project-aware automation.
+
+Open an existing generated project with `open_project` to run project-aware
+module operations against the recorded authority:
+
+```python
+from pathlib import Path
+
+from modwire.projects import open_project
+
+project = open_project(Path("services/acme"))
+
+project.add_context("commerce")
+project.add_module("billing", context_name="commerce")
+project.remove_module("billing", context_name="commerce", dry_run=True)
+```
+
+The currently exposed project helpers cover reading the project authority,
+adding contexts, adding modules, removing modules, and removing contexts. Module
+generation uses the project's configured `module_scaffolding` and language output
+root, so Python, TypeScript, and PHP profiles place generated files under their
+own layout conventions.
+
+Bundled project profiles currently include:
+
+- `python-fastapi-ddd-uv`
+- `typescript-nestjs-ddd-pnpm`
+- `php-symfony-ddd-composer`
 
 ## Configuration
 

{modwire-3.1.1 → modwire-3.2.0}/README.md

@@ -99,7 +99,56 @@ generate_module(
 ```
 
 If no template path is provided, `generate_module` uses the bundled `layered`
-scaffolding. Bundled scaffoldings are packaged with the distribution wheel.
+scaffolding. Pass `scaffolding="hexagonal"` for a pluggable domain/ports/adapters
+structure, `scaffolding="clean"` for a domain/application/infrastructure/interface
+module, or `scaffolding="ddd_context"` for a bounded-context module. Bundled
+scaffoldings are packaged with the distribution wheel.
+
+## Project Generation
+
+`modwire.projects` can generate a project authority and starter layout. The
+default bundled project profile is `python-fastapi-ddd-uv`: Python, uv,
+FastAPI, and a DDD-oriented package layout that mounts reusable `ddd_context`
+module scaffolding under the application package.
+
+```python
+from pathlib import Path
+
+from modwire.projects import generate_project
+
+generate_project("acme", Path("services/acme"))
+```
+
+The generated project includes `.modwire/project.json`, which records the
+resolved profile, layout, dependencies, module scaffolding, and operation names
+for later project-aware automation.
+
+Open an existing generated project with `open_project` to run project-aware
+module operations against the recorded authority:
+
+```python
+from pathlib import Path
+
+from modwire.projects import open_project
+
+project = open_project(Path("services/acme"))
+
+project.add_context("commerce")
+project.add_module("billing", context_name="commerce")
+project.remove_module("billing", context_name="commerce", dry_run=True)
+```
+
+The currently exposed project helpers cover reading the project authority,
+adding contexts, adding modules, removing modules, and removing contexts. Module
+generation uses the project's configured `module_scaffolding` and language output
+root, so Python, TypeScript, and PHP profiles place generated files under their
+own layout conventions.
+
+Bundled project profiles currently include:
+
+- `python-fastapi-ddd-uv`
+- `typescript-nestjs-ddd-pnpm`
+- `php-symfony-ddd-composer`
 
 ## Configuration
 

{modwire-3.1.1 → modwire-3.2.0}/pyproject.toml

@@ -78,6 +78,10 @@ include-package-data = true
     "scaffoldings/*/copier.yml",
     "scaffoldings/*/template/**/*.jinja",
 ]
+"modwire.projects" = [
+    "scaffoldings/*/copier.yml",
+    "scaffoldings/*/template/**/*.jinja",
+]
 
 [tool.setuptools.packages.find]
 where = ["src"]

{modwire-3.1.1 → modwire-3.2.0}/src/modwire/_version.py

@@ -18,7 +18,7 @@ version_tuple: tuple[int | str, ...]
 commit_id: str | None
 __commit_id__: str | None
 
-__version__ = version = '3.1.1'
-__version_tuple__ = version_tuple = (3, 1, 1)
+__version__ = version = '3.2.0'
+__version_tuple__ = version_tuple = (3, 2, 0)
 
 __commit_id__ = commit_id = None

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/copier.yml

@@ -0,0 +1,48 @@
+_min_copier_version: "9.0.0"
+_templates_suffix: ".jinja"
+_subdirectory: template
+
+module_name:
+  type: str
+  default: sample_module
+  help: Importable module or package directory name.
+
+module_class_name:
+  type: str
+  default: "{{ module_name | replace('-', '_') | replace(' ', '_') | title | replace('_', '') }}"
+  help: PascalCase module name used to derive default class names.
+
+aggregate_name:
+  type: str
+  default: "{{ module_class_name }}Aggregate"
+  help: Domain aggregate class name.
+
+entity_name:
+  type: str
+  default: "{{ module_class_name }}Entity"
+  help: Domain entity class name.
+
+use_case_name:
+  type: str
+  default: "Create{{ module_class_name }}"
+  help: Application use case class name.
+
+repository_name:
+  type: str
+  default: "{{ module_class_name }}Repository"
+  help: Repository port and adapter class suffix.
+
+controller_name:
+  type: str
+  default: "{{ module_class_name }}Controller"
+  help: Interface controller class name.
+
+event_name:
+  type: str
+  default: "{{ module_class_name }}Created"
+  help: Domain event class name.
+
+php_namespace:
+  type: str
+  default: "App\\{{ module_class_name }}"
+  help: PHP namespace root for the generated classes.

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/php/src/Application/Ports/{{ repository_name }}.php.jinja

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace {{ php_namespace }}\Application\Ports;
+
+use {{ php_namespace }}\Domain\Entities\{{ entity_name }};
+
+interface {{ repository_name }}
+{
+    public function save({{ entity_name }} $entity): void;
+
+    public function get(string $entityId): ?{{ entity_name }};
+}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/php/src/Application/UseCases/{{ use_case_name }}.php.jinja

@@ -0,0 +1,32 @@
+<?php
+
+declare(strict_types=1);
+
+namespace {{ php_namespace }}\Application\UseCases;
+
+use {{ php_namespace }}\Application\Ports\{{ repository_name }};
+use {{ php_namespace }}\Domain\Entities\{{ entity_name }};
+
+final class {{ use_case_name }}Command
+{
+    public function __construct(
+        public readonly string $entityId,
+        public readonly string $name,
+    ) {
+    }
+}
+
+final class {{ use_case_name }}
+{
+    public function __construct(private readonly {{ repository_name }} $repository)
+    {
+    }
+
+    public function execute({{ use_case_name }}Command $command): {{ entity_name }}
+    {
+        $entity = {{ entity_name }}::create($command->entityId, $command->name);
+        $this->repository->save($entity);
+
+        return $entity;
+    }
+}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/php/src/Domain/Entities/{{ entity_name }}.php.jinja

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace {{ php_namespace }}\Domain\Entities;
+
+use {{ php_namespace }}\Domain\Events\{{ event_name }};
+use {{ php_namespace }}\Domain\Exceptions\{{ entity_name }}ValidationException;
+
+final class {{ entity_name }}
+{
+    /** @var list<{{ event_name }}> */
+    private array $events = [];
+
+    private function __construct(
+        public readonly string $entityId,
+        public readonly string $name,
+    ) {
+    }
+
+    public static function create(string $entityId, string $name): self
+    {
+        if ($entityId === '') {
+            throw new {{ entity_name }}ValidationException('Entity id cannot be empty');
+        }
+
+        if ($name === '') {
+            throw new {{ entity_name }}ValidationException('Entity name cannot be empty');
+        }
+
+        $entity = new self($entityId, $name);
+        $entity->events[] = new {{ event_name }}($entityId, $name);
+
+        return $entity;
+    }
+
+    /** @return list<{{ event_name }}> */
+    public function pullEvents(): array
+    {
+        $events = $this->events;
+        $this->events = [];
+
+        return $events;
+    }
+}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/php/src/Domain/Events/{{ event_name }}.php.jinja

@@ -0,0 +1,14 @@
+<?php
+
+declare(strict_types=1);
+
+namespace {{ php_namespace }}\Domain\Events;
+
+final class {{ event_name }}
+{
+    public function __construct(
+        public readonly string $entityId,
+        public readonly string $name,
+    ) {
+    }
+}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/php/src/Domain/Exceptions/{{ entity_name }}ValidationException.php.jinja

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace {{ php_namespace }}\Domain\Exceptions;
+
+use InvalidArgumentException;
+
+final class {{ entity_name }}ValidationException extends InvalidArgumentException
+{
+}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/php/src/Infrastructure/Persistence/InMemory{{ repository_name }}.php.jinja

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace {{ php_namespace }}\Infrastructure\Persistence;
+
+use {{ php_namespace }}\Application\Ports\{{ repository_name }};
+use {{ php_namespace }}\Domain\Entities\{{ entity_name }};
+
+final class InMemory{{ repository_name }} implements {{ repository_name }}
+{
+    /** @var array<string, {{ entity_name }}> */
+    private array $items = [];
+
+    public function save({{ entity_name }} $entity): void
+    {
+        $this->items[$entity->entityId] = $entity;
+    }
+
+    public function get(string $entityId): ?{{ entity_name }}
+    {
+        return $this->items[$entityId] ?? null;
+    }
+}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/php/src/Interface/Http/{{ controller_name }}.php.jinja

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace {{ php_namespace }}\Interface\Http;
+
+use {{ php_namespace }}\Application\UseCases\{{ use_case_name }};
+use {{ php_namespace }}\Application\UseCases\{{ use_case_name }}Command;
+
+final class {{ controller_name }}
+{
+    public function __construct(private readonly {{ use_case_name }} $useCase)
+    {
+    }
+
+    /** @return array{id: string, name: string} */
+    public function create(string $entityId, string $name): array
+    {
+        $entity = $this->useCase->execute(new {{ use_case_name }}Command($entityId, $name));
+
+        return ['id' => $entity->entityId, 'name' => $entity->name];
+    }
+}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/__init__.py.jinja

@@ -0,0 +1 @@
+"""Clean architecture module for {{ module_name }}."""

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/application/__init__.py.jinja

@@ -0,0 +1 @@
+"""Application business rules for {{ module_name }}."""

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/application/ports/__init__.py.jinja

@@ -0,0 +1 @@
+"""Application ports."""

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/application/ports/{{ repository_name | lower }}.py.jinja

@@ -0,0 +1,13 @@
+from __future__ import annotations
+
+from typing import Protocol
+
+from ...domain.entities.{{ entity_name | lower }} import {{ entity_name }}
+
+
+class {{ repository_name }}(Protocol):
+    def save(self, entity: {{ entity_name }}) -> None:
+        ...
+
+    def get(self, entity_id: str) -> {{ entity_name }} | None:
+        ...

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/application/use_cases/__init__.py.jinja

@@ -0,0 +1 @@
+"""Application use cases."""

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/application/use_cases/{{ use_case_name | lower }}.py.jinja

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from dataclasses import dataclass
+
+from ...domain.entities.{{ entity_name | lower }} import {{ entity_name }}
+from ..ports.{{ repository_name | lower }} import {{ repository_name }}
+
+
+@dataclass(frozen=True)
+class {{ use_case_name }}Command:
+    entity_id: str
+    name: str
+
+
+class {{ use_case_name }}:
+    def __init__(self, repository: {{ repository_name }}) -> None:
+        self._repository = repository
+
+    def execute(self, command: {{ use_case_name }}Command) -> {{ entity_name }}:
+        entity = {{ entity_name }}.create(command.entity_id, command.name)
+        self._repository.save(entity)
+        return entity

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/domain/__init__.py.jinja

@@ -0,0 +1 @@
+"""Enterprise business rules for {{ module_name }}."""

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/domain/entities/__init__.py.jinja

@@ -0,0 +1 @@
+"""Domain entities."""

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/domain/entities/{{ entity_name | lower }}.py.jinja

@@ -0,0 +1,35 @@
+from __future__ import annotations
+
+from dataclasses import dataclass, field
+
+from ..events.{{ event_name | lower }} import {{ event_name }}
+from ..exceptions.{{ entity_name | lower }}validationerror import (
+    {{ entity_name }}ValidationError,
+)
+
+
+@dataclass
+class {{ entity_name }}:
+    entity_id: str
+    name: str
+    _events: list[{{ event_name }}] = field(
+        default_factory=list,
+        init=False,
+        repr=False,
+    )
+
+    @classmethod
+    def create(cls, entity_id: str, name: str) -> "{{ entity_name }}":
+        if not entity_id:
+            raise {{ entity_name }}ValidationError("Entity id cannot be empty")
+        if not name:
+            raise {{ entity_name }}ValidationError("Entity name cannot be empty")
+
+        entity = cls(entity_id=entity_id, name=name)
+        entity._events.append({{ event_name }}(entity_id=entity_id, name=name))
+        return entity
+
+    def pull_events(self) -> tuple[{{ event_name }}, ...]:
+        events = tuple(self._events)
+        self._events.clear()
+        return events

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/domain/events/__init__.py.jinja

@@ -0,0 +1 @@
+"""Domain events."""

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/domain/events/{{ event_name | lower }}.py.jinja

@@ -0,0 +1,7 @@
+from dataclasses import dataclass
+
+
+@dataclass(frozen=True)
+class {{ event_name }}:
+    entity_id: str
+    name: str

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/domain/exceptions/__init__.py.jinja

@@ -0,0 +1 @@
+"""Domain exceptions."""

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/domain/exceptions/{{ entity_name | lower }}validationerror.py.jinja

@@ -0,0 +1,2 @@
+class {{ entity_name }}ValidationError(ValueError):
+    """Raised when {{ entity_name }} invariants are violated."""

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/infrastructure/__init__.py.jinja

@@ -0,0 +1 @@
+"""Framework and driver details for {{ module_name }}."""

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/infrastructure/persistence/__init__.py.jinja

@@ -0,0 +1 @@
+"""Persistence adapters."""

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/infrastructure/persistence/inmemory{{ repository_name | lower }}.py.jinja

@@ -0,0 +1,14 @@
+from __future__ import annotations
+
+from ...domain.entities.{{ entity_name | lower }} import {{ entity_name }}
+
+
+class InMemory{{ repository_name }}:
+    def __init__(self) -> None:
+        self._items: dict[str, {{ entity_name }}] = {}
+
+    def save(self, entity: {{ entity_name }}) -> None:
+        self._items[entity.entity_id] = entity
+
+    def get(self, entity_id: str) -> {{ entity_name }} | None:
+        return self._items.get(entity_id)

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/interface/__init__.py.jinja

@@ -0,0 +1 @@
+"""Interface adapters for {{ module_name }}."""

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/interface/http/__init__.py.jinja

@@ -0,0 +1 @@
+"""HTTP interface adapters."""

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/python/{{ module_name }}/interface/http/{{ controller_name | lower }}.py.jinja

@@ -0,0 +1,15 @@
+from __future__ import annotations
+
+from ...application.use_cases.{{ use_case_name | lower }} import (
+    {{ use_case_name }},
+    {{ use_case_name }}Command,
+)
+
+
+class {{ controller_name }}:
+    def __init__(self, use_case: {{ use_case_name }}) -> None:
+        self._use_case = use_case
+
+    def create(self, entity_id: str, name: str) -> dict[str, str]:
+        entity = self._use_case.execute({{ use_case_name }}Command(entity_id, name))
+        return {"id": entity.entity_id, "name": entity.name}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/typescript/{{ module_name }}/application/ports/{{ repository_name }}.ts.jinja

@@ -0,0 +1,6 @@
+import { {{ entity_name }} } from "../../domain/entities/{{ entity_name }}";
+
+export interface {{ repository_name }} {
+  save(entity: {{ entity_name }}): void;
+  get(entityId: string): {{ entity_name }} | undefined;
+}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/typescript/{{ module_name }}/application/use_cases/{{ use_case_name }}.ts.jinja

@@ -0,0 +1,19 @@
+import { {{ entity_name }} } from "../../domain/entities/{{ entity_name }}";
+import { {{ repository_name }} } from "../ports/{{ repository_name }}";
+
+export class {{ use_case_name }}Command {
+  constructor(
+    public readonly entityId: string,
+    public readonly name: string,
+  ) {}
+}
+
+export class {{ use_case_name }} {
+  constructor(private readonly repository: {{ repository_name }}) {}
+
+  execute(command: {{ use_case_name }}Command): {{ entity_name }} {
+    const entity = {{ entity_name }}.create(command.entityId, command.name);
+    this.repository.save(entity);
+    return entity;
+  }
+}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/typescript/{{ module_name }}/domain/entities/{{ entity_name }}.ts.jinja

@@ -0,0 +1,31 @@
+import { {{ event_name }} } from "../events/{{ event_name }}";
+import { {{ entity_name }}ValidationError } from "../exceptions/{{ entity_name }}ValidationError";
+
+export class {{ entity_name }} {
+  private events: {{ event_name }}[] = [];
+
+  private constructor(
+    public readonly entityId: string,
+    public readonly name: string,
+  ) {}
+
+  static create(entityId: string, name: string): {{ entity_name }} {
+    if (!entityId) {
+      throw new {{ entity_name }}ValidationError("Entity id cannot be empty");
+    }
+
+    if (!name) {
+      throw new {{ entity_name }}ValidationError("Entity name cannot be empty");
+    }
+
+    const entity = new {{ entity_name }}(entityId, name);
+    entity.events.push(new {{ event_name }}(entityId, name));
+    return entity;
+  }
+
+  pullEvents(): readonly {{ event_name }}[] {
+    const pulled = [...this.events];
+    this.events = [];
+    return pulled;
+  }
+}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/typescript/{{ module_name }}/domain/events/{{ event_name }}.ts.jinja

@@ -0,0 +1,6 @@
+export class {{ event_name }} {
+  constructor(
+    public readonly entityId: string,
+    public readonly name: string,
+  ) {}
+}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/typescript/{{ module_name }}/domain/exceptions/{{ entity_name }}ValidationError.ts.jinja

@@ -0,0 +1 @@
+export class {{ entity_name }}ValidationError extends Error {}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/typescript/{{ module_name }}/infrastructure/persistence/InMemory{{ repository_name }}.ts.jinja

@@ -0,0 +1,14 @@
+import { {{ entity_name }} } from "../../domain/entities/{{ entity_name }}";
+import { {{ repository_name }} } from "../../application/ports/{{ repository_name }}";
+
+export class InMemory{{ repository_name }} implements {{ repository_name }} {
+  private readonly items = new Map<string, {{ entity_name }}>();
+
+  save(entity: {{ entity_name }}): void {
+    this.items.set(entity.entityId, entity);
+  }
+
+  get(entityId: string): {{ entity_name }} | undefined {
+    return this.items.get(entityId);
+  }
+}

modwire-3.2.0/src/modwire/modules/scaffoldings/clean/template/typescript/{{ module_name }}/interface/http/{{ controller_name }}.ts.jinja

@@ -0,0 +1,10 @@
+import { {{ use_case_name }}, {{ use_case_name }}Command } from "../../application/use_cases/{{ use_case_name }}";
+
+export class {{ controller_name }} {
+  constructor(private readonly useCase: {{ use_case_name }}) {}
+
+  create(entityId: string, name: string): { id: string; name: string } {
+    const entity = this.useCase.execute(new {{ use_case_name }}Command(entityId, name));
+    return { id: entity.entityId, name: entity.name };
+  }
+}