Adding rules for modular monolith architectures (#16)

Author: floriankraemer

README.md

@@ -19,6 +19,8 @@ See individual rule documentation for detailed configuration examples. A [full c
 ### Architecture Rules
 
 - [Dependency Constraints Rule](docs/rules/Dependency-Constraints-Rule.md)
+- [Modular Architecture Rule](docs/rules/Modular-Architecture-Rule.md)
+- [Circular Module Dependency Rule](docs/rules/Circular-Module-Dependency-Rule.md)
 - [Forbidden Namespaces Rule](docs/rules/Forbidden-Namespaces-Rule.md)
 - [Class Must Be Readonly Rule](docs/rules/Class-Must-Be-Readonly-Rule.md)
 - [Class Must Be Final Rule](docs/rules/Class-Must-Be-Final-Rule.md)

data/ModularArchitectureTest/Capability/Billing/Application/CircularDep.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Capability\Billing\Application;
+
+use App\Capability\UserManagement\UserManagementFacade;
+
+/**
+ * Creates circular dependency:
+ * Billing → UserManagement
+ * UserManagement would depend on ProductCatalog (in ValidCrossModule)
+ * If we make ProductCatalog depend on Billing, we get a cycle
+ */
+class CircularDep
+{
+    public function __construct(
+        private UserManagementFacade $userManagement
+    ) {
+    }
+}
+

data/ModularArchitectureTest/Capability/Billing/BillingFacade.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Capability\Billing;
+
+/**
+ * Facade for Billing module
+ */
+class BillingFacade
+{
+    public function processBilling(): void
+    {
+    }
+}
+

data/ModularArchitectureTest/Capability/ProductCatalog/Application/CreateCircular.php

@@ -0,0 +1,37 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Capability\ProductCatalog\Application;
+
+use App\Capability\Billing\BillingFacade;
+
+/**
+ * This creates a circular dependency when combined with Billing/Application/CircularDep.php:
+ * ProductCatalog → Billing → UserManagement → ProductCatalog (via ValidCrossModule)
+ * 
+ * Wait, let me reconsider. ValidCrossModule has:
+ * ProductCatalog → UserManagement
+ * 
+ * CircularDep has:
+ * Billing → UserManagement
+ * 
+ * This file has:
+ * ProductCatalog → Billing
+ * 
+ * So we don't quite have a cycle yet. Let me think...
+ * We need: A → B → C → A
+ * 
+ * Let's make it simpler:
+ * - ProductCatalog → UserManagement (ValidCrossModule)
+ * - UserManagement → Billing (need to create this)
+ * - Billing → ProductCatalog (this file creates it)
+ */
+class CreateCircular
+{
+    public function __construct(
+        private BillingFacade $billing
+    ) {
+    }
+}
+

data/ModularArchitectureTest/Capability/ProductCatalog/Application/InvalidCrossModule.php

@@ -0,0 +1,18 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Capability\ProductCatalog\Application;
+
+use App\Capability\UserManagement\UserManagementException;
+
+/**
+ * Invalid: Importing exception from another module
+ */
+class InvalidCrossModule
+{
+    public function __construct()
+    {
+    }
+}
+

data/ModularArchitectureTest/Capability/ProductCatalog/Application/UseCustomDto.php

@@ -0,0 +1,21 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Capability\ProductCatalog\Application;
+
+use App\Capability\UserManagement\UserManagementDto;
+
+/**
+ * This imports a DTO class from another module.
+ * - With default config: This is INVALID (only Facade, FacadeInterface, Input, Result allowed)
+ * - With custom pattern '/Dto$/': This is VALID
+ */
+class UseCustomDto
+{
+    public function __construct(
+        private UserManagementDto $dto
+    ) {
+    }
+}
+

data/ModularArchitectureTest/Capability/ProductCatalog/Application/ValidCrossModule.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Capability\ProductCatalog\Application;
+
+use App\Capability\UserManagement\UserManagementFacade;
+use App\Capability\UserManagement\UserManagementFacadeInterface;
+use App\Capability\UserManagement\Application\UseCases\CreateUser\CreateUserInput;
+use App\Capability\UserManagement\Application\UseCases\CreateUser\CreateUserResult;
+
+/**
+ * Valid cross-module imports: Facade, FacadeInterface, Input, Result
+ */
+class ValidCrossModule
+{
+    public function __construct(
+        private UserManagementFacadeInterface $userManagement
+    ) {
+    }
+
+    public function doSomething(): void
+    {
+        $input = new CreateUserInput('123', 'John Doe');
+        $result = $this->userManagement->createUser($input);
+    }
+}
+

data/ModularArchitectureTest/Capability/ProductCatalog/Domain/Model/Product.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Capability\ProductCatalog\Domain\Model;
+
+/**
+ * Valid domain entity
+ */
+class Product
+{
+    public function __construct(
+        private string $id,
+        private string $name
+    ) {
+    }
+
+    public function getId(): string
+    {
+        return $this->id;
+    }
+
+    public function getName(): string
+    {
+        return $this->name;
+    }
+}
+

data/ModularArchitectureTest/Capability/ProductCatalog/ProductCatalogFacade.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Capability\ProductCatalog;
+
+/**
+ * Facade for ProductCatalog module
+ */
+class ProductCatalogFacade
+{
+    public function getProducts(): array
+    {
+        return [];
+    }
+}
+

data/ModularArchitectureTest/Capability/UserManagement/Application/CreateCircularToUserManagement.php

@@ -0,0 +1,24 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Capability\UserManagement\Application;
+
+use App\Capability\ProductCatalog\ProductCatalogFacade;
+
+/**
+ * This completes the circular dependency:
+ * - ProductCatalog → Billing (CreateCircular.php in ProductCatalog, analyzed first)
+ * - Billing → UserManagement (CircularDep.php in Billing, analyzed second)
+ * - UserManagement → ProductCatalog (this file, analyzed third, creates cycle)
+ *
+ * Expected cycle: ProductCatalog → Billing → UserManagement → ProductCatalog
+ */
+class CreateCircularToUserManagement
+{
+    public function __construct(
+        private ProductCatalogFacade $productCatalog
+    ) {
+    }
+}
+