Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions data/Service/AbstractServiceClass.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
<?php

namespace App\Service;

abstract class AbstractServiceClass
{
abstract public function doSomething(): void;
}
4 changes: 4 additions & 0 deletions docs/Rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,14 @@ Ensures that classes matching specified patterns are declared as `final`.
class: Phauthentic\PHPStanRules\Architecture\ClassMustBeFinalRule
arguments:
patterns: ['/^App\\Service\\/']
ignoreAbstractClasses: true
tags:
- phpstan.rules.rule
```

- `patterns`: Array of regex patterns to match against class names.
- `ignoreAbstractClasses`: Whether to ignore abstract classes (default: `true`).

## Namespace Class Pattern Rule {#namespace-class-pattern-rule}

Ensures that classes inside namespaces matching a given regex must have names matching at least one of the provided patterns.
Expand Down
8 changes: 7 additions & 1 deletion src/Architecture/ClassMustBeFinalRule.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,8 @@ class ClassMustBeFinalRule implements Rule
* Each pattern should be a valid PCRE regex.
*/
public function __construct(
protected array $patterns
protected array $patterns,
protected bool $ignoreAbstractClasses = true
) {
}

Expand All @@ -47,6 +48,11 @@ public function processNode(Node $node, Scope $scope): array
return [];
}

// Skip abstract classes if configured to ignore them
if ($this->ignoreAbstractClasses && $node->isAbstract()) {
return [];
}

$className = $node->name->toString();
$namespaceName = $scope->getNamespace() ?? '';
$fullClassName = $namespaceName . '\\' . $className;
Expand Down
5 changes: 5 additions & 0 deletions tests/TestCases/Architecture/ClassMustBeFinalRuleTest.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,4 +28,9 @@ public function testRule(): void
],
]);
}

public function testRuleIgnoresAbstractClassesByDefault(): void
{
$this->analyse([__DIR__ . '/../../../data/Service/AbstractServiceClass.php'], []);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<?php

declare(strict_types=1);

namespace Phauthentic\PHPStanRules\Tests\TestCases\Architecture;

use Phauthentic\PHPStanRules\Architecture\ClassMustBeFinalRule;
use PHPStan\Testing\RuleTestCase;

/**
* @extends RuleTestCase<ClassMustBeFinalRule>
*/
class ClassMustBeFinalRuleWithAbstractClassesTest extends RuleTestCase
{
protected function getRule(): \PHPStan\Rules\Rule
{
return new ClassMustBeFinalRule([
'/ServiceClass$/', // all classes that end with "ServiceClass"
], false); // Don't ignore abstract classes
}

public function testRuleWithAbstractClassesNotIgnored(): void
{
$this->analyse([__DIR__ . '/../../../data/Service/AbstractServiceClass.php'], [
[
'Class App\Service\AbstractServiceClass must be final.',
5,
],
]);
}


}