Added rules for enforcing abstract/interface/trait naming convention

extension.neon

@@ -7,3 +7,4 @@ parameters:
 		- stubs/Money/MoneyParser.stub
 rules:
     - Ibexa\PHPStan\Rules\NoConfigResolverParametersInConstructorRule
+    - Ibexa\PHPStan\Rules\ClassTypeNamingRule

phpstan.neon

@@ -1,3 +1,6 @@
+includes:
+    - phpstan-baseline.neon
+
 parameters:
     level: 8
     paths:

rules/ClassTypeNamingRule.php

@@ -0,0 +1,75 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\PHPStan\Rules;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Rules\Rule;
+use PHPStan\Rules\RuleErrorBuilder;
+
+/**
+ * @implements \PHPStan\Rules\Rule<\PhpParser\Node\Stmt\ClassLike>
+ */
+final class ClassTypeNamingRule implements Rule
+{
+    public function getNodeType(): string
+    {
+        return Node\Stmt\ClassLike::class;
+    }
+
+    public function processNode(Node $node, Scope $scope): array
+    {
+        if (!$this->isRelevantNode($node)) {
+            return [];
+        }
+
+        if ($node->name === null) {
+            return [];
+        }
+
+        $className = $node->name->toString();
+        $errors = [];
+
+        if ($node instanceof Node\Stmt\Interface_ && substr($className, -9) !== 'Interface') {
+            $errors[] = RuleErrorBuilder::message(
+                sprintf(
+                    'Interface "%s" should have "Interface" suffix',
+                    $className
+                )
+            )->build();
+        }
+
+        if ($node instanceof Node\Stmt\Trait_ && substr($className, -5) !== 'Trait') {
+            $errors[] = RuleErrorBuilder::message(
+                sprintf(
+                    'Trait "%s" should have "Trait" suffix',
+                    $className
+                )
+            )->build();
+        }
+
+        if ($node instanceof Node\Stmt\Class_ && $node->isAbstract() && strpos($className, 'Abstract') !== 0) {
+            $errors[] = RuleErrorBuilder::message(
+                sprintf(
+                    'Abstract class "%s" should have "Abstract" prefix',
+                    $className
+                )
+            )->build();
+        }
+
+        return $errors;
+    }
+
+    private function isRelevantNode(Node $node): bool
+    {
+        return $node instanceof Node\Stmt\Interface_
+            || $node instanceof Node\Stmt\Trait_
+            || ($node instanceof Node\Stmt\Class_ && $node->isAbstract());
+    }
+}

tests/rules/ClassTypeNamingRuleTest.php

@@ -0,0 +1,52 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Tests\PHPStan\Rules;
+
+use Ibexa\PHPStan\Rules\ClassTypeNamingRule;
+use PHPStan\Rules\Rule;
+use PHPStan\Testing\RuleTestCase;
+
+/**
+ * @extends \PHPStan\Testing\RuleTestCase<\Ibexa\PHPStan\Rules\ClassTypeNamingRule>
+ */
+final class ClassTypeNamingRuleTest extends RuleTestCase
+{
+    protected function getRule(): Rule
+    {
+       return new ClassTypeNamingRule();
+    }
+
+    public function testRule(): void
+    {
+        $this->analyse(
+            [
+                __DIR__ . '/Fixtures/ClassTypeNaming/WrongName.php',
+                __DIR__ . '/Fixtures/ClassTypeNaming/SimpleThing.php',
+                __DIR__ . '/Fixtures/ClassTypeNaming/SimpleClass.php',
+                __DIR__ . '/Fixtures/ClassTypeNaming/CorrectNameInterface.php',
+                __DIR__ . '/Fixtures/ClassTypeNaming/CorrectNameTrait.php',
+                __DIR__ . '/Fixtures/ClassTypeNaming/AbstractCorrectClass.php',
+            ],
+            [
+                [
+                    'Interface "WrongName" should have "Interface" suffix',
+                    11,
+                ],
+                [
+                    'Trait "SimpleThing" should have "Trait" suffix',
+                    11,
+                ],
+                [
+                    'Abstract class "SimpleClass" should have "Abstract" prefix',
+                    11,
+                ],
+            ]
+        );
+    }
+}

tests/rules/Fixtures/ClassTypeNaming/AbstractCorrectClass.php

@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Tests\PHPStan\Rules\Fixtures\ClassTypeNaming;
+
+abstract class AbstractCorrectClass
+{
+}

tests/rules/Fixtures/ClassTypeNaming/CorrectNameInterface.php

@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Tests\PHPStan\Rules\Fixtures\ClassTypeNaming;
+
+interface CorrectNameInterface
+{
+}

tests/rules/Fixtures/ClassTypeNaming/CorrectNameTrait.php

@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Tests\PHPStan\Rules\Fixtures\ClassTypeNaming;
+
+trait CorrectNameTrait
+{
+}

tests/rules/Fixtures/ClassTypeNaming/SimpleClass.php

@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Tests\PHPStan\Rules\Fixtures\ClassTypeNaming;
+
+abstract class SimpleClass
+{
+}

tests/rules/Fixtures/ClassTypeNaming/SimpleThing.php

@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Tests\PHPStan\Rules\Fixtures\ClassTypeNaming;
+
+trait SimpleThing
+{
+}

tests/rules/Fixtures/ClassTypeNaming/WrongName.php

@@ -0,0 +1,13 @@
+<?php
+
+/**
+ * @copyright Copyright (C) Ibexa AS. All rights reserved.
+ * @license For full copyright and license information view LICENSE file distributed with this source code.
+ */
+declare(strict_types=1);
+
+namespace Ibexa\Tests\PHPStan\Rules\Fixtures\ClassTypeNaming;
+
+interface WrongName
+{
+}