Add tests to skip non-modular and anonymous classes in architecture rules

Florian Krämer · Florian Krämer · commit 390c96adde3d · 2026-02-10T00:01:32.000+01:00
- Introduced tests in CircularModuleDependencyRuleTest to skip non-modular namespaces and same module imports.
- Added tests in ClassMustBeFinalRuleTest to ensure final classes and anonymous classes are correctly handled.
- Updated ForbiddenAccessorsRuleTest to skip anonymous classes.
- Enhanced ForbiddenStaticMethodsRuleTest to skip dynamic method and class names.

These additions improve the robustness of the architecture rules by ensuring that specific cases are properly ignored during analysis.
diff --git a/data/BoolNaming/EdgeCaseMethodBoolClass.php b/data/BoolNaming/EdgeCaseMethodBoolClass.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace App\BoolNaming;
+
+class EdgeCaseMethodBoolClass
+{
+    public function __construct()
+    {
+    }
+
+    public function __toString(): string
+    {
+        return 'test';
+    }
+
+    public function noReturnType()
+    {
+        return true;
+    }
+
+    public function isValid(): bool
+    {
+        return true;
+    }
+
+    public function check(): bool
+    {
+        return true;
+    }
+}
diff --git a/data/Forbidden/ChildService.php b/data/Forbidden/ChildService.php
@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Forbidden;
+
+class ChildService extends ForbiddenService
+{
+    public function callParent(): string
+    {
+        return parent::create();
+    }
+}
diff --git a/data/Forbidden/ForbiddenService.php b/data/Forbidden/ForbiddenService.php
@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Forbidden;
+
+class ForbiddenService
+{
+    public static function create(): string
+    {
+        return 'created';
+    }
+
+    public function callSelf(): string
+    {
+        return self::create();
+    }
+
+    public function callStatic(): string
+    {
+        return static::create();
+    }
+}
diff --git a/data/ForbiddenAccessors/AnonymousClassWithAccessors.php b/data/ForbiddenAccessors/AnonymousClassWithAccessors.php
@@ -0,0 +1,14 @@
+<?php
+
+namespace App\Domain;
+
+$entity = new class {
+    public function getName(): string
+    {
+        return 'name';
+    }
+
+    public function setName(string $name): void
+    {
+    }
+};
diff --git a/data/ForbiddenStaticMethods/DynamicCall.php b/data/ForbiddenStaticMethods/DynamicCall.php
@@ -0,0 +1,20 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Service;
+
+class DynamicCallService
+{
+    public function dynamicMethod(): void
+    {
+        $method = 'calculate';
+        \App\Utils\StaticHelper::$method();
+    }
+
+    public function dynamicClass(): void
+    {
+        $class = \App\Utils\StaticHelper::class;
+        $class::calculate();
+    }
+}
diff --git a/data/MethodMustReturnType/EdgeCaseTestClass.php b/data/MethodMustReturnType/EdgeCaseTestClass.php
@@ -0,0 +1,28 @@
+<?php
+
+class EdgeCaseTestClass
+{
+    public function noReturnTypeWithType() { return 1; }
+
+    public function noReturnTypeWithOneOf() { return 'test'; }
+
+    public function noReturnTypeWithAllOf() { return 1; }
+
+    public function objectReturnsInt(): int { return 1; }
+
+    public function anyOfInvalid(): float { return 1.0; }
+
+    public function anyOfValid(): int { return 1; }
+
+    public function regexTypeValid(): SomeEdgeCaseObject { return new SomeEdgeCaseObject(); }
+
+    public function regexTypeInvalid(): float { return 1.0; }
+
+    public function validInt(): int { return 1; }
+    public function validNullableString(): ?string { return null; }
+    public function validVoid(): void { return; }
+    public function validObject(): SomeEdgeCaseObject { return new SomeEdgeCaseObject(); }
+    public function validNullableObject(): ?SomeEdgeCaseObject { return null; }
+}
+
+class SomeEdgeCaseObject {}
diff --git a/data/ModularArchitectureTest/Capability/ProductCatalog/Application/NonModularImport.php b/data/ModularArchitectureTest/Capability/ProductCatalog/Application/NonModularImport.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Capability\ProductCatalog\Application;
+
+use DateTime;
+
+class NonModularImport
+{
+    public function getDate(): DateTime
+    {
+        return new DateTime();
+    }
+}
diff --git a/data/ModularArchitectureTest/Capability/UserManagement/Application/SameModuleImport.php b/data/ModularArchitectureTest/Capability/UserManagement/Application/SameModuleImport.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\Capability\UserManagement\Application;
+
+use App\Capability\UserManagement\UserManagementFacade;
+
+class SameModuleImport
+{
+    public function __construct(
+        private UserManagementFacade $facade
+    ) {
+    }
+}
diff --git a/data/ModularArchitectureTest/NonModular/OutsideClass.php b/data/ModularArchitectureTest/NonModular/OutsideClass.php
@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace App\NonModular;
+
+use App\Capability\UserManagement\UserManagementFacade;
+
+class OutsideClass
+{
+    public function __construct(
+        private UserManagementFacade $facade
+    ) {
+    }
+}
diff --git a/data/Service/AnonymousServiceClass.php b/data/Service/AnonymousServiceClass.php
@@ -0,0 +1,9 @@
+<?php
+
+namespace App\Service;
+
+$anonymous = new class {
+    public function doSomething(): void
+    {
+    }
+};
diff --git a/data/Service/FinalRuleService.php b/data/Service/FinalRuleService.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace App\Service;
+
+final class FinalRuleService
+{
+}
diff --git a/tests/TestCases/Architecture/CircularModuleDependencyRuleTest.php b/tests/TestCases/Architecture/CircularModuleDependencyRuleTest.php
@@ -34,6 +34,33 @@ public function testNoCircularDependencies(): void
         );
     }
 
+    public function testNonModularNamespaceIsSkipped(): void
+    {
+        // A class outside the modular namespace should be ignored
+        $this->analyse(
+            [__DIR__ . '/../../../data/ModularArchitectureTest/NonModular/OutsideClass.php'],
+            []
+        );
+    }
+
+    public function testSameModuleImportIsSkipped(): void
+    {
+        // Importing from the same module should not trigger any errors
+        $this->analyse(
+            [__DIR__ . '/../../../data/ModularArchitectureTest/Capability/UserManagement/Application/SameModuleImport.php'],
+            []
+        );
+    }
+
+    public function testModularFileImportingNonModularClassIsSkipped(): void
+    {
+        // A modular file importing a non-modular class (e.g., DateTime) should be skipped
+        $this->analyse(
+            [__DIR__ . '/../../../data/ModularArchitectureTest/Capability/ProductCatalog/Application/NonModularImport.php'],
+            []
+        );
+    }
+
     public function testCircularDependencyDetection(): void
     {
         // Reset to ensure clean state
diff --git a/tests/TestCases/Architecture/ClassMustBeFinalRuleTest.php b/tests/TestCases/Architecture/ClassMustBeFinalRuleTest.php
@@ -33,4 +33,16 @@ public function testRuleIgnoresAbstractClassesByDefault(): void
     {
         $this->analyse([__DIR__ . '/../../../data/Service/AbstractServiceClass.php'], []);
     }
+
+    public function testFinalClassMatchingPatternPassesRule(): void
+    {
+        // A class that matches the pattern but is already final should produce no errors
+        $this->analyse([__DIR__ . '/../../../data/Service/FinalRuleService.php'], []);
+    }
+
+    public function testAnonymousClassIsSkipped(): void
+    {
+        // Anonymous classes should be skipped (no class name to match)
+        $this->analyse([__DIR__ . '/../../../data/Service/AnonymousServiceClass.php'], []);
+    }
 }
diff --git a/tests/TestCases/Architecture/ForbiddenAccessorsRuleExceptionsTest.php b/tests/TestCases/Architecture/ForbiddenAccessorsRuleExceptionsTest.php
@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phauthentic\PHPStanRules\Tests\TestCases\Architecture;
+
+use Phauthentic\PHPStanRules\Architecture\ForbiddenAccessorsRule;
+use PHPUnit\Framework\TestCase;
+
+class ForbiddenAccessorsRuleExceptionsTest extends TestCase
+{
+    public function testEmptyClassPatternsThrowsException(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('At least one class pattern must be provided.');
+        new ForbiddenAccessorsRule(classPatterns: []);
+    }
+
+    public function testInvalidVisibilityThrowsException(): void
+    {
+        $this->expectException(\InvalidArgumentException::class);
+        $this->expectExceptionMessage('Invalid visibility value(s): invalid');
+        new ForbiddenAccessorsRule(classPatterns: ['/./'], visibility: ['invalid']);
+    }
+}
diff --git a/tests/TestCases/Architecture/ForbiddenAccessorsRulePrivateVisibilityTest.php b/tests/TestCases/Architecture/ForbiddenAccessorsRulePrivateVisibilityTest.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phauthentic\PHPStanRules\Tests\TestCases\Architecture;
+
+use Phauthentic\PHPStanRules\Architecture\ForbiddenAccessorsRule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<ForbiddenAccessorsRule>
+ */
+class ForbiddenAccessorsRulePrivateVisibilityTest extends RuleTestCase
+{
+    protected function getRule(): ForbiddenAccessorsRule
+    {
+        return new ForbiddenAccessorsRule(
+            classPatterns: ['/\\\\Domain\\\\.*Entity$/'],
+            forbidGetters: true,
+            forbidSetters: true,
+            visibility: ['private']
+        );
+    }
+
+    public function testPrivateAccessorsAreDetected(): void
+    {
+        $this->analyse([__DIR__ . '/../../../data/ForbiddenAccessors/EntityWithAccessors.php'], [
+            [
+                'Class App\Domain\UserEntity must not have a private getter method getPrivateValue().',
+                41,
+            ],
+            [
+                'Class App\Domain\UserEntity must not have a private setter method setPrivateValue().',
+                46,
+            ],
+        ]);
+    }
+}
diff --git a/tests/TestCases/Architecture/ForbiddenAccessorsRuleTest.php b/tests/TestCases/Architecture/ForbiddenAccessorsRuleTest.php
@@ -48,4 +48,10 @@ public function testRuleDoesNotMatchNonEntityClasses(): void
     {
         $this->analyse([__DIR__ . '/../../../data/ForbiddenAccessors/ServiceWithAccessors.php'], []);
     }
+
+    public function testAnonymousClassIsSkipped(): void
+    {
+        // Anonymous classes should be skipped (resolveFullClassName returns null)
+        $this->analyse([__DIR__ . '/../../../data/ForbiddenAccessors/AnonymousClassWithAccessors.php'], []);
+    }
 }
diff --git a/tests/TestCases/Architecture/ForbiddenStaticMethodsRuleSelfStaticParentTest.php b/tests/TestCases/Architecture/ForbiddenStaticMethodsRuleSelfStaticParentTest.php
@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Phauthentic\PHPStanRules\Tests\TestCases\Architecture;
+
+use Phauthentic\PHPStanRules\Architecture\ForbiddenStaticMethodsRule;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends RuleTestCase<ForbiddenStaticMethodsRule>
+ */
+class ForbiddenStaticMethodsRuleSelfStaticParentTest extends RuleTestCase
+{
+    protected function getRule(): Rule
+    {
+        return new ForbiddenStaticMethodsRule([
+            '/^App\\\\Forbidden\\\\ForbiddenService::.*/',
+        ]);
+    }
+
+    public function testSelfAndStaticCalls(): void
+    {
+        $this->analyse([__DIR__ . '/../../../data/Forbidden/ForbiddenService.php'], [
+            [
+                'Static method call "App\Forbidden\ForbiddenService::create" is forbidden.',
+                16,
+            ],
+            [
+                'Static method call "App\Forbidden\ForbiddenService::create" is forbidden.',
+                21,
+            ],
+        ]);
+    }
+
+    public function testParentCall(): void
+    {
+        $this->analyse([__DIR__ . '/../../../data/Forbidden/ChildService.php'], [
+            [
+                'Static method call "App\Forbidden\ForbiddenService::create" is forbidden.',
+                11,
+            ],
+        ]);
+    }
+}
diff --git a/tests/TestCases/Architecture/ForbiddenStaticMethodsRuleTest.php b/tests/TestCases/Architecture/ForbiddenStaticMethodsRuleTest.php
@@ -65,4 +65,10 @@ public function testAllowedMethodOnPartiallyForbiddenClass(): void
         // DateTime::getLastErrors is allowed, only createFromFormat is forbidden
         $this->analyse([__DIR__ . '/../../../data/ForbiddenStaticMethods/AllowedMethodOnForbiddenClass.php'], []);
     }
+
+    public function testDynamicCallsAreSkipped(): void
+    {
+        // Dynamic method names ($method) and dynamic class names ($class) should be skipped
+        $this->analyse([__DIR__ . '/../../../data/ForbiddenStaticMethods/DynamicCall.php'], []);
+    }
 }
diff --git a/tests/TestCases/Architecture/MethodMustReturnTypeRuleEdgeCasesTest.php b/tests/TestCases/Architecture/MethodMustReturnTypeRuleEdgeCasesTest.php
diff --git a/tests/TestCases/Architecture/MethodsReturningBoolMustFollowNamingConventionEdgeCasesTest.php b/tests/TestCases/Architecture/MethodsReturningBoolMustFollowNamingConventionEdgeCasesTest.php
diff --git a/tests/TestCases/Architecture/PropertyMustMatchRuleExceptionsTest.php b/tests/TestCases/Architecture/PropertyMustMatchRuleExceptionsTest.php
diff --git a/tests/TestCases/Architecture/PropertyMustMatchRuleIntersectionTypeTest.php b/tests/TestCases/Architecture/PropertyMustMatchRuleIntersectionTypeTest.php
diff --git a/tests/TestCases/Architecture/PropertyMustMatchRuleInvalidRegexTest.php b/tests/TestCases/Architecture/PropertyMustMatchRuleInvalidRegexTest.php
diff --git a/tests/TestCases/Architecture/PropertyMustMatchRuleInvalidVisibilityTest.php b/tests/TestCases/Architecture/PropertyMustMatchRuleInvalidVisibilityTest.php
